com.centrasite.control.types
Class ListReport

java.lang.Object
  extended by com.centrasite.control.discovery.AbstractReport
      extended by com.centrasite.control.types.ListReport
All Implemented Interfaces:
ItemsProvider, ReportInterface

public class ListReport
extends AbstractReport

This is a special type of report used to show items contained in lists (JAXR - RegistryPackage). Does not support server side sorting or scrolling.


Field Summary
 
Fields inherited from interface com.centrasite.control.ReportInterface
ASCENDING, DESCENDING, FLAG_ADD_CONTEXT_MENU_METHOD, FLAG_NONE, FLAG_NOT_PART_OF_COLUMNS, FLAG_NOT_PART_OF_CSVCOLUMN, FLAG_NOT_PART_OF_LINES, FLAG_RENDER_ITEM_IMAGE, FLAG_RENDER_READ_ONLY, FLAG_RENDER_REFERENCE_ITEM_IMAGE, FLAG_RENDER_VALUE_AS_CHECKBOX, FLAG_RENDER_VALUE_AS_IMAGEPROP, FLAG_RENDER_VALUE_WITH_METHODLINK, FLAG_SORT_BY_DEFAULT_ASC, FLAG_SORT_BY_DEFAULT_DESC, FLAG_SORT_ICON_INVISIBLE, FLAG_VISIBLE_ALWAYS, FLAG_VISIBLE_BY_DEFAULT
 
Constructor Summary
ListReport(Connector connector, java.util.Locale locale, SortedItemsProvider sortedItemsProvider)
           
 
Method Summary
 java.util.List getContextMenuCommands(Item item)
          Obtain the commands list to be displayed on context menu request.
 java.lang.String getDescription(java.util.Locale locale)
          Get description of report
 java.lang.String getImageURL()
          Get URL of icon
 java.lang.String getTitle(java.util.Locale locale)
          Get title of report
 java.lang.String toXhtml()
          Transform the report to XHTML.
 
Methods inherited from class com.centrasite.control.discovery.AbstractReport
addAccessor, addAccessor, addDynamicColumns, appendUserHeading, clearCommands, duplicate, endProcess, execute, getAccessor, getAllHeadings, getAllHeadingsNotPartOfColumn, getCommands, getFixedColumnHeadings, getHeadings, getHeadingsNotPartOfColumn, getId, getItem, getItem, getItems, getLocale, getNonEmptyTitle, getOnSelectCommand, getPropertyAccessor, getPropertyAccessorFlags, getRows, getSelectedItem, getToolbarCommands, hasPropertyAccessorWithFlag, hasUserConfiguration, implicitlyAddRefreshCommand, implicitlyAddSaveReportCommand, implicitlyAddSelectColumnsCommand, initializeUserHeadings, initializeUserHeadings, prepareItems, removeCommand, resetUserHeadings, setItem, setItemsProvider, setLocale, setSelectedItem, supportsDelayedRead, suppressColumns, suppressProperty, toXhtml
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ListReport

public ListReport(Connector connector,
                  java.util.Locale locale,
                  SortedItemsProvider sortedItemsProvider)
Method Detail

getDescription

public java.lang.String getDescription(java.util.Locale locale)
                                throws java.lang.Exception
Description copied from interface: ReportInterface
Get description of report

Throws:
java.lang.Exception

getImageURL

public java.lang.String getImageURL()
                             throws java.lang.Exception
Description copied from interface: ReportInterface
Get URL of icon

Returns:
null if no image available
Throws:
java.lang.Exception

getTitle

public java.lang.String getTitle(java.util.Locale locale)
                          throws java.lang.Exception
Description copied from interface: ReportInterface
Get title of report

Throws:
java.lang.Exception

toXhtml

public java.lang.String toXhtml()
Description copied from class: AbstractReport
Transform the report to XHTML.

Specified by:
toXhtml in interface ReportInterface
Overrides:
toXhtml in class AbstractReport

getContextMenuCommands

public java.util.List getContextMenuCommands(Item item)
Description copied from interface: ReportInterface
Obtain the commands list to be displayed on context menu request.

Specified by:
getContextMenuCommands in interface ReportInterface
Overrides:
getContextMenuCommands in class AbstractReport
Returns:
Copy of this item commands collection.
See Also:
Can be overridden by implementors in order to provide custom list of commands.