Interface IAction
- All Known Subinterfaces:
IDataAction
public interface IAction
Defines an interface that allows engine to pass hyperlink information to an
emitter, if the emitter determines to customize the hyperlinks calculated in
engine, or it wants to use a totally different hyperlink string
Because it is allowed to customize hyperlinks through emitters, hyperlink customization in presentation engine itself is not supported now. It could be added later if it deems necessary.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
bookmark actionstatic final int
drillthrough actionstatic final int
hyperlink action -
Method Summary
Modifier and TypeMethodDescriptionreturn fomat of drillthrough reportint
getType()
boolean
Return the bookmark type set in the drillthrough action.
-
Field Details
-
ACTION_HYPERLINK
static final int ACTION_HYPERLINKhyperlink action- See Also:
-
ACTION_BOOKMARK
static final int ACTION_BOOKMARKbookmark action- See Also:
-
ACTION_DRILLTHROUGH
static final int ACTION_DRILLTHROUGHdrillthrough action- See Also:
-
-
Method Details
-
getType
int getType()- Returns:
- the type of the hyperlink
-
getBookmark
String getBookmark()- Returns:
- the bookmark string
-
getActionString
String getActionString()- Returns:
- the action string that is calculated using the engine's default algorithm. valid for all three action types.
-
getSystemId
String getSystemId()- Returns:
- the system id of the report design which create this action.
-
getReportName
String getReportName()- Returns:
- the report name if action type is drillthrough, null otherwise
-
getParameterBindings
Map getParameterBindings()- Returns:
- a set of name/value pairs for running the report in a drillthrough link; null when the action type is not drillthrough, or no parameters are defined for the drillthrough report to run. In the future, when the drillthrough is against a report document, the parameter binding map is also null.
-
getSearchCriteria
Map getSearchCriteria()- Returns:
- a set of name/value pairs for searching the report in a drillthrough link; null when the action type is not drillthrough, or no search criteria is used
-
getTargetWindow
String getTargetWindow()- Returns:
- The name of a frame where a document is to be opened.
-
getFormat
String getFormat()return fomat of drillthrough report- Returns:
-
isBookmark
boolean isBookmark()Return the bookmark type set in the drillthrough action. The return result indicated the target element is a toc or not.- Returns:
true
, the target element is a bookmark.false
, the target element is indicated to be a toc.
-
getTargetFileType
String getTargetFileType()- Returns:
- the type of the target report file.
-
getTooltip
String getTooltip()
-