|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAction
Script wrapper of ActionHandle
Method Summary | |
---|---|
java.lang.String |
getFormatType()
Gets the format type of the action. |
java.lang.String |
getLinkType()
Gets the link type of the action. |
java.lang.String |
getReportName()
Gets the name of the target report document if the link type is ACTION_LINK_TYPE_DRILLTHROUGH . |
java.lang.String |
getTargetBookmark()
Gets the bookmark link if the link type is ACTION_LINK_TYPE_BOOKMARK_LINK . |
java.lang.String |
getTargetWindow()
Gets the name of the target browser window for the link. |
java.lang.String |
getURI()
Gets the identifier of the hyperlink if the link type is ACTION_LINK_TYPE_HYPERLINK . |
void |
setFormatType(java.lang.String type)
Sets the format type of the action. |
void |
setLinkType(java.lang.String type)
Sets the link type of the action. |
void |
setReportName(java.lang.String reportName)
Sets target report name for a drill-though link. |
void |
setTargetBookmark(java.lang.String bookmark)
Sets the target bookmark defined within this same report, or another report for a drill-though link. |
void |
setTargetWindow(java.lang.String window)
Sets the target window of the action. |
void |
setURI(java.lang.String uri)
Sets the hyperlink of this action. |
Method Detail |
---|
java.lang.String getURI()
ACTION_LINK_TYPE_HYPERLINK
. Otherwise, return null.
java.lang.String getTargetWindow()
java.lang.String getLinkType()
ACTION_LINK_TYPE_NONE
ACTION_LINK_TYPE_HYPERLINK
ACTION_LINK_TYPE_DRILLTHROUGH
ACTION_LINK_TYPE_BOOKMARK_LINK
org.eclipse.birt.report.model.api.elements.DesignChoiceConstants
void setLinkType(java.lang.String type) throws ScriptException
ACTION_LINK_TYPE_NONE
ACTION_LINK_TYPE_HYPERLINK
ACTION_LINK_TYPE_DRILLTHROUGH
ACTION_LINK_TYPE_BOOKMARK_LINK
type
- type of the action.
ScriptException
- if the type
is not one of the above.void setFormatType(java.lang.String type) throws ScriptException
ACTION_FORMAT_TYPE_HTML
ACTION_FORMAT_TYPE_PDF
type
- the type of the action
ScriptException
java.lang.String getFormatType()
ACTION_FORMAT_TYPE_HTML
ACTION_FORMAT_TYPE_PDF
void setTargetWindow(java.lang.String window) throws ScriptException
window
- the target window name
ScriptException
- if this property is locked.void setURI(java.lang.String uri) throws ScriptException
ACTION_LINK_TYPE_HYPERLINK
.
uri
- the hyperlink to set
ScriptException
- if the property is locked.java.lang.String getReportName()
ACTION_LINK_TYPE_DRILLTHROUGH
. Otherwise, return null.
setReportName(String)
void setReportName(java.lang.String reportName) throws ScriptException
ACTION_LINK_TYPE_DRILLTHROUGH
. The report name
can include relative or absolute names. If the suffix is omitted, it is
computed on the server by looking for a matching report. BIRT reports are
searched in the following order: 1) a BIRT report document or 2) a BIRT
report design.
reportName
- the name of the target report
ScriptException
- if the property is locked.getReportName()
java.lang.String getTargetBookmark()
ACTION_LINK_TYPE_BOOKMARK_LINK
. Otherwise, return null.
void setTargetBookmark(java.lang.String bookmark) throws ScriptException
setLinkType(String)
to do
the link type change, it can either be
ACTION_LINK_TYPE_DRILLTHROUGH
or
ACTION_LINK_TYPE_BOOKMARK_LINK
.
bookmark
- the bookmark value.
ScriptException
- if the property is locked.getTargetBookmark()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |