|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.ActionHandle
public class ActionHandle
Represents an "action" (hyperlink) attached to an element. Obtain an instance
of this class by calling the getActionHandle
method on the
handle of an element that defines an action.
The link type of an Action can be only one of hyperlink, bookmark Link or drill-through.
DataItemHandle.getActionHandle()
,
ImageHandle.getActionHandle()
,
LabelHandle.getActionHandle()
,
Action
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structRef |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
ActionHandle(DesignElementHandle element,
org.eclipse.birt.report.model.core.MemberRef ref)
Construct an handle to deal with the action structure. |
Method Summary | |
---|---|
void |
addParamBinding(ParamBinding paramBinding)
Add a new parameter binding to the action. |
void |
addSearch(SearchKey key)
Add a new search key to the action. |
java.lang.String |
getBookmarkLink()
Deprecated. use getTargetBookmark() instead. |
java.lang.String |
getDrillThroughReportName()
Deprecated. use getReportName() instead. |
java.lang.String |
getFormatType()
Gets the format type of the action. |
java.lang.String |
getHyperlink()
Deprecated. use getURI() instead. |
java.lang.String |
getLinkType()
Gets the link type of the action. |
MemberHandle |
getParamBindings()
Get a handle to deal with the parameter binding list member if the link type is ACTION_LINK_TYPE_DRILLTHROUGH . |
java.lang.String |
getReportName()
Gets the name of the target report document if the link type is ACTION_LINK_TYPE_DRILLTHROUGH . |
MemberHandle |
getSearch()
Get a handle to deal with the search key list member 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 |
getTargetBookmarkType()
Gets target bookmark type for a drill-through or bookmark-link action. |
java.lang.String |
getTargetFileType()
Gets target report file type for a drill-through action. |
java.lang.String |
getTargetWindow()
Gets the name of the target browser window for the link. |
java.lang.String |
getToolTip()
Gets the value of tool tip. |
java.lang.String |
getURI()
Gets the identifier of the hyperlink if the link type is ACTION_LINK_TYPE_HYPERLINK . |
java.util.Iterator |
paramBindingsIterator()
Gets the parameter binding list of a drill-through action if the link type is ACTION_LINK_TYPE_DRILLTHROUGH . |
java.util.Iterator |
searchIterator()
Gets the search key list for a drill-through action if the link type is ACTION_LINK_TYPE_DRILLTHROUGH and the drill through type
is DRILL_THROUGH_LINK_TYPE_SEARCH . |
void |
setBookmarkLink(java.lang.String bookmark)
Deprecated. use setTargetBookmark(String) instead. |
void |
setDrillThroughBookmarkLink(java.lang.String bookmark)
Deprecated. use setTargetBookmark(String) instead. |
void |
setDrillThroughReportName(java.lang.String reportName)
Deprecated. use setReportName(String) instead. |
void |
setDrillThroughTargetBookmark(java.lang.String bookmark)
Deprecated. use setTargetBookmark(String) instead. |
void |
setFormatType(java.lang.String type)
Sets the format type of the action. |
void |
setHyperlink(java.lang.String hyperlink)
Deprecated. setURI(String) |
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 |
setTargetBookmarkType(java.lang.String targetBookmarkType)
Sets target bookmark type for a drill-through or bookmark-link action. |
void |
setTargetFileType(java.lang.String targetFileType)
Sets target report file type for a drill-through action. |
void |
setTargetWindow(java.lang.String window)
Sets the target window of the action. |
void |
setToolTip(java.lang.String toolTip)
Sets the value of the tool tip. |
void |
setURI(java.lang.String uri)
Sets the hyperlink of this action. |
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ActionHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)
element
- the element that defined the action.ref
- reference to the action property.Method Detail |
---|
public java.lang.String getHyperlink()
getURI()
instead.
ACTION_LINK_TYPE_HYPERLINK
. Otherwise, return null.
public java.lang.String getURI()
ACTION_LINK_TYPE_HYPERLINK
. Otherwise, return null.
public java.lang.String getTargetWindow()
public java.lang.String getLinkType()
ACTION_LINK_TYPE_NONE
ACTION_LINK_TYPE_HYPERLINK
ACTION_LINK_TYPE_DRILLTHROUGH
ACTION_LINK_TYPE_BOOKMARK_LINK
DesignChoiceConstants
public void setLinkType(java.lang.String type) throws SemanticException
ACTION_LINK_TYPE_NONE
ACTION_LINK_TYPE_HYPERLINK
ACTION_LINK_TYPE_DRILLTHROUGH
ACTION_LINK_TYPE_BOOKMARK_LINK
type
- type of the action.
SemanticException
- if the type
is not one of the above.public void setFormatType(java.lang.String type) throws SemanticException
ACTION_FORMAT_TYPE_HTML
ACTION_FORMAT_TYPE_PDF
type
- the type of the action
SemanticException
public java.lang.String getFormatType()
ACTION_FORMAT_TYPE_HTML
ACTION_FORMAT_TYPE_PDF
public java.lang.String getToolTip()
public void setToolTip(java.lang.String toolTip) throws SemanticException
toolTip
- the value of tool tip.
SemanticException
public MemberHandle getParamBindings()
ACTION_LINK_TYPE_DRILLTHROUGH
. Otherwise, return
null.
public void addParamBinding(ParamBinding paramBinding) throws SemanticException
paramBinding
- a new parameter binding to be added.
SemanticException
- if the parameter binding is not validpublic MemberHandle getSearch()
ACTION_LINK_TYPE_DRILLTHROUGH
. Otherwise, return null.
public void addSearch(SearchKey key) throws SemanticException
key
- a new search key to be added.
SemanticException
- if the value is not valid.public void setTargetWindow(java.lang.String window) throws SemanticException
window
- the target window name
SemanticException
- if this property is locked.public void setHyperlink(java.lang.String hyperlink) throws SemanticException
setURI(String)
ACTION_LINK_TYPE_HYPERLINK
.
hyperlink
- the hyperlink to set
SemanticException
- if the property is locked.getHyperlink()
public void setURI(java.lang.String uri) throws SemanticException
ACTION_LINK_TYPE_HYPERLINK
.
uri
- the hyperlink to set
SemanticException
- if the property is locked.public java.lang.String getDrillThroughReportName()
getReportName()
instead.
ACTION_LINK_TYPE_DRILLTHROUGH
. Otherwise, return null.
setDrillThroughReportName(String)
public java.lang.String getReportName()
ACTION_LINK_TYPE_DRILLTHROUGH
. Otherwise, return null.
setReportName(String)
public void setDrillThroughReportName(java.lang.String reportName) throws SemanticException
setReportName(String)
instead.
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
SemanticException
- if the property is locked.getDrillThroughReportName()
public void setReportName(java.lang.String reportName) throws SemanticException
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
SemanticException
- if the property is locked.getReportName()
public void setDrillThroughBookmarkLink(java.lang.String bookmark) throws SemanticException
setTargetBookmark(String)
instead.
ACTION_LINK_TYPE_DRILLTHROUGH
, and drill-through type
will be changed to DRILL_THROUGH_LINK_TYPE_BOOKMARK_LINK
.
bookmark
- the bookmark to set.
SemanticException
- if the property is locked.getBookmarkLink()
public java.lang.String getBookmarkLink()
getTargetBookmark()
instead.
ACTION_LINK_TYPE_BOOKMARK_LINK
. Otherwise, return null.
public java.lang.String getTargetBookmark()
ACTION_LINK_TYPE_BOOKMARK_LINK
. Otherwise, return null.
public void setTargetBookmark(java.lang.String bookmark) throws SemanticException
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.
SemanticException
- if the property is locked.getTargetBookmark()
public void setDrillThroughTargetBookmark(java.lang.String bookmark) throws SemanticException
setTargetBookmark(String)
instead.
ACTION_LINK_TYPE_DRILLTHROUGH
.
bookmark
- the bookmark to set.
SemanticException
- if the property is locked.getTargetBookmark()
public void setBookmarkLink(java.lang.String bookmark) throws SemanticException
setTargetBookmark(String)
instead.
ACTION_LINK_TYPE_BOOKMARK_LINK
.
bookmark
- the expression value.
SemanticException
- if the property is locked.getBookmarkLink()
public java.util.Iterator paramBindingsIterator()
ACTION_LINK_TYPE_DRILLTHROUGH
. Each one is the
instance of ParameBindingHandle
Action binds a data value in the report to a report parameter defined in the target report.
Note that this is a parameter binding, not a parameter definition. The report makes no attempt to check that the parameters listed here are accurate in name or type for the target report. Also, it is legal to bind the same parameter multiple times; the meaning depends on the semantics of the target report.
public java.util.Iterator searchIterator()
ACTION_LINK_TYPE_DRILLTHROUGH
and the drill through type
is DRILL_THROUGH_LINK_TYPE_SEARCH
. Each one is the
instance of SearchKeyHandle
The search key list identifies search criteria in the target report and is used for drill-though links. The search is assumed to be quality. That is, identify a column defined in the target report and a data value defined in this report. The link will then search for this value.
public void setTargetFileType(java.lang.String targetFileType) throws SemanticException
ACTION_TARGET_FILE_TYPE_REPORT_DESIGN
ACTION_TARGET_FILE_TYPE_REPORT_DOCUMENT
targetFileType
- the type of the target report file
SemanticException
- if type of the target report file is not in the choice list.getTargetFileType()
public java.lang.String getTargetFileType()
ACTION_TARGET_FILE_TYPE_REPORT_DESIGN
ACTION_TARGET_FILE_TYPE_REPORT_DOCUMENT
public void setTargetBookmarkType(java.lang.String targetBookmarkType) throws SemanticException
ACTION_BOOKMARK_TYPE_BOOKMARK
ACTION_BOOKMARK_TYPE_TOC
targetBookmarkType
- the type of the target bookmark
SemanticException
- if type of the target bookmark is not in the choice list.getTargetBookmarkType()
public java.lang.String getTargetBookmarkType()
ACTION_BOOKMARK_TYPE_BOOKMARK
ACTION_BOOKMARK_TYPE_TOC
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |