|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ReportInterface
Definition of of report interface.
Field Summary | |
---|---|
static int |
ASCENDING
Sort ASCENDING |
static int |
DESCENDING
Sort DESCENDING |
static int |
FLAG_ADD_CONTEXT_MENU_METHOD
The accessor value will support showing context menu. |
static int |
FLAG_NONE
default: column is rendered part of a CSVColumn and can be hidden dynamically |
static int |
FLAG_NOT_PART_OF_COLUMNS
the accessor will not be rendered as a column is not part of CSVColumn and thus always visible |
static int |
FLAG_NOT_PART_OF_CSVCOLUMN
column is not part of CSVColumn and thus always visible |
static int |
FLAG_NOT_PART_OF_LINES
the accessor value will not be rendered in the report content but its column will |
static int |
FLAG_RENDER_ITEM_IMAGE
The item's image (Item.getImageUrl()) will be added in addition to the accessor value. |
static int |
FLAG_RENDER_READ_ONLY
display read only |
static int |
FLAG_RENDER_REFERENCE_ITEM_IMAGE
|
static int |
FLAG_RENDER_VALUE_AS_CHECKBOX
The accessor value will be rendered as checkbox. |
static int |
FLAG_RENDER_VALUE_AS_IMAGEPROP
the accessor will associated with the image prop of the line |
static int |
FLAG_RENDER_VALUE_WITH_METHODLINK
The accessor value will be rendered as methodlink. |
static int |
FLAG_SORT_BY_DEFAULT_ASC
sort by default ascending |
static int |
FLAG_SORT_BY_DEFAULT_DESC
sort by default descending |
static int |
FLAG_SORT_ICON_INVISIBLE
display sort icon |
static int |
FLAG_VISIBLE_ALWAYS
column must always be visible, is part of CSVColumn |
static int |
FLAG_VISIBLE_BY_DEFAULT
column is rendered part of a CSVColumn and is visible by default |
Method Summary | |
---|---|
boolean |
appendUserHeading(java.lang.String heading)
Append a user heading element for this report NOTE: If a heading is set, then only these headings will be given back on the next execute. |
void |
endProcess()
Notify that processing of this report has finished |
void |
execute()
Compute the report. |
java.util.HashMap |
getAccessor()
Get hashmap containing accessors for all headings |
java.util.List |
getAllHeadings()
Get all the heading that can be displayed in a table for this type |
java.util.List |
getAllHeadingsNotPartOfColumn()
Get all line properties that are not displayed as column (eg description) |
java.util.List |
getCommands()
Get set of commands to be rendered (for example in a toolbar) for this report. |
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.util.List |
getFixedColumnHeadings()
Get the list of headers/columns for this report which shall always be visible |
java.util.List |
getHeadings()
Get the list of visible headers/columns for this report |
java.util.List |
getHeadingsNotPartOfColumn()
Get all line properties that are not displayed as column (eg description) |
java.lang.String |
getId()
Get id for type of report |
java.lang.String |
getImageURL()
Get URL of icon |
Item |
getItem()
Get the Item this report is based on |
java.lang.String |
getNonEmptyTitle()
|
com.softwareag.cis.plugin.command.Command |
getOnSelectCommand(Item item)
Obtain the command to be executed when selecting a row in the report |
PropertyAccessor |
getPropertyAccessor(java.lang.String internalName)
Get PropertyAccessor for given internal name of heading |
RowIterator |
getRows()
Get the rows of the report |
java.lang.String |
getTitle(java.util.Locale locale)
Get title of report |
java.util.List |
getToolbarCommands()
Obtain the commands list to be displayed within the report toolbar. |
boolean |
hasPropertyAccessorWithFlag(java.lang.String internalName,
int flags)
Check whether given flags are set for PropertyAccessor |
boolean |
hasUserConfiguration()
Method can be used to determine if for current user a configuration exist. |
boolean |
implicitlyAddRefreshCommand()
Check whether the standard "Refresh" command shall implicitly be added to this report's toolbar |
boolean |
implicitlyAddSaveReportCommand()
Check whether the standard "Save Report" command shall implicitly be added to this report's toolbar. |
boolean |
implicitlyAddSelectColumnsCommand()
Check whether the standard "Select Columns" command shall implicitly be added to this report's toolbar |
void |
initializeUserHeadings(Connector con)
Initialize the user selected headings. |
void |
initializeUserHeadings(GUIConfigurationExt config,
java.lang.String user,
java.lang.String password)
Initialize the user selected headings. |
void |
removeCommand(java.lang.Class commandClass)
Remove command corresponding to given class from set of commands |
void |
resetUserHeadings()
Reset the current user heading - that way you can add new ones using setUserHeading() |
void |
setItem(Item item)
Set the Item to get the report on |
void |
setItemsProvider(ItemsProvider itemProvider)
Set data source providing set of items to be rendered |
java.lang.String |
toXhtml()
Transform the report to XHTML. |
java.lang.String |
toXhtml(Connector connector)
Transform the report to XHTML. |
Field Detail |
---|
static final int FLAG_NONE
static final int FLAG_VISIBLE_BY_DEFAULT
static final int FLAG_VISIBLE_ALWAYS
static final int FLAG_NOT_PART_OF_CSVCOLUMN
static final int FLAG_NOT_PART_OF_COLUMNS
static final int FLAG_RENDER_VALUE_WITH_METHODLINK
static final int FLAG_ADD_CONTEXT_MENU_METHOD
FLAG_RENDER_VALUE_WITH_METHODLINK
.
static final int FLAG_NOT_PART_OF_LINES
static final int FLAG_RENDER_VALUE_AS_IMAGEPROP
static final int FLAG_SORT_BY_DEFAULT_ASC
static final int FLAG_SORT_BY_DEFAULT_DESC
static final int FLAG_SORT_ICON_INVISIBLE
static final int FLAG_RENDER_READ_ONLY
static final int FLAG_RENDER_VALUE_AS_CHECKBOX
static final int FLAG_RENDER_ITEM_IMAGE
FLAG_RENDER_VALUE_AS_IMAGEPROP
where only image is rendered and
the accessor value is taken as the image url. Used only with textgrid.
static final int FLAG_RENDER_REFERENCE_ITEM_IMAGE
static final int DESCENDING
static final int ASCENDING
Method Detail |
---|
java.lang.String getId()
Item getItem()
void setItem(Item item)
java.lang.String getTitle(java.util.Locale locale) throws java.lang.Exception
java.lang.Exception
java.lang.String getDescription(java.util.Locale locale) throws java.lang.Exception
java.lang.Exception
java.lang.String getImageURL() throws java.lang.Exception
java.lang.Exception
java.util.List getCommands()
void removeCommand(java.lang.Class commandClass)
commandClass
- class of command to be removedboolean implicitlyAddRefreshCommand()
boolean implicitlyAddSelectColumnsCommand()
boolean implicitlyAddSaveReportCommand()
java.util.HashMap getAccessor()
PropertyAccessor getPropertyAccessor(java.lang.String internalName)
internalName
- internal name of heading
boolean hasPropertyAccessorWithFlag(java.lang.String internalName, int flags)
internalName
- internal name of PropertyAccessorflags
- flags to be tested whether set for PropertyAccessor
java.lang.NullPointerException
- if invalid propertyName specifiedjava.util.List getHeadings()
java.util.List getFixedColumnHeadings()
java.util.List getAllHeadings()
java.util.List getAllHeadingsNotPartOfColumn()
java.util.List getHeadingsNotPartOfColumn()
void resetUserHeadings()
appendUserHeading(String)
boolean appendUserHeading(java.lang.String heading)
heading
- heading name
void initializeUserHeadings(Connector con)
con
- the Connector allowing access to the user settingsvoid initializeUserHeadings(GUIConfigurationExt config, java.lang.String user, java.lang.String password)
config
- user configurationuser
- user name used to obtained selected headings.password
- user passwordRowIterator getRows()
void execute() throws java.lang.Exception
java.lang.Exception
java.lang.String toXhtml()
java.lang.String toXhtml(Connector connector)
java.lang.String getNonEmptyTitle()
com.softwareag.cis.plugin.command.Command getOnSelectCommand(Item item)
item
-
java.util.List getContextMenuCommands(Item item)
item
-
java.util.List getToolbarCommands()
void setItemsProvider(ItemsProvider itemProvider)
itemProvider
- void endProcess()
boolean hasUserConfiguration()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |