Interface IActionInstance
-
public interface IActionInstance
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description IDrillThroughInstancecreateDrillThrough()create a empty drillThrough instance.IDrillThroughInstancecreateDrillThrough(java.lang.String bookmark, boolean isBookmark, java.lang.String reportName, java.util.Map parameterBindings, java.util.Map searchCriteria, java.lang.String target, java.lang.String format)Deprecated.Create a drillThrough instance.IDrillThroughInstancecreateDrillThrough(java.lang.String bookmark, boolean isBookmark, java.lang.String reportName, java.util.Map parameterBindings, java.util.Map searchCriteria, java.lang.String target, java.lang.String format, java.lang.String targetFileType)Create a drillThrough instance.java.lang.StringgetBookmark()IDrillThroughInstancegetDrillThrough()java.lang.StringgetHyperlink()java.lang.StringgetTargetWindow()java.lang.StringgetTooltip()intgetType()voidsetBookmark(java.lang.String bookmark)Set bookmark.voidsetDrillThrough(IDrillThroughInstance drillThroughInstance)Set IDrillThroughInstance.voidsetHyperlink(java.lang.String hyperlink, java.lang.String target)Set hyperlink string and target.voidsetTooltip(java.lang.String tooltip)
-
-
-
Method Detail
-
getType
int getType()
- Returns:
- the type of the hyperlink. Can be one of the following: org.eclipse.birt.report.engine.content.IHyperlinkAction.ACTION_HYPERLINK org.eclipse.birt.report.engine.content.IHyperlinkAction.ACTION_BOOKMARK org.eclipse.birt.report.engine.content.IHyperlinkAction.ACTION_DRILLTHROUGH ACTION NULL: -1
-
getBookmark
java.lang.String getBookmark()
- Returns:
- the bookmark string when action type is bookmark. Otherwise, throw RuntimeException.
-
setBookmark
void setBookmark(java.lang.String bookmark)
Set bookmark. And set the type be org.eclipse.birt.report.engine.content.IHyperlinkAction.ACTION_BOOKMARK Throw IllegalArgumentException if the bookmark be set to null.- Parameters:
bookmark-
-
getHyperlink
java.lang.String getHyperlink()
- Returns:
- the action string when action type is hyperlink. Otherwise, throw RuntimeException.
-
setHyperlink
void setHyperlink(java.lang.String hyperlink, java.lang.String target)Set hyperlink string and target. And set the type be org.eclipse.birt.report.engine.content.IHyperlinkAction.ACTION_HYPERLINK Throw IllegalArgumentException if the hyperlink be set to null.- Parameters:
hyperlink-target-
-
getTargetWindow
java.lang.String getTargetWindow()
- Returns:
- The name of a frame where a target hyperlink or drillThrough to be opened.
-
createDrillThrough
@Deprecated IDrillThroughInstance createDrillThrough(java.lang.String bookmark, boolean isBookmark, java.lang.String reportName, java.util.Map parameterBindings, java.util.Map searchCriteria, java.lang.String target, java.lang.String format)
Deprecated.Create a drillThrough instance. And set the parameters of the drillthrough:- Parameters:
bookmark-isBookmark-reportName-parameterBindings-searchCriteria-target-format-
-
createDrillThrough
IDrillThroughInstance createDrillThrough(java.lang.String bookmark, boolean isBookmark, java.lang.String reportName, java.util.Map parameterBindings, java.util.Map searchCriteria, java.lang.String target, java.lang.String format, java.lang.String targetFileType)
Create a drillThrough instance. And set the parameters of the drillthrough:- Parameters:
bookmark-isBookmark-reportName-parameterBindings-searchCriteria-target-format-targetFileType-
-
createDrillThrough
IDrillThroughInstance createDrillThrough()
create a empty drillThrough instance.- Returns:
-
getDrillThrough
IDrillThroughInstance getDrillThrough()
- Returns:
- the drillThrouthInstance when action type is drillThrough. Otherwise, throw RuntimeException.
-
setDrillThrough
void setDrillThrough(IDrillThroughInstance drillThroughInstance)
Set IDrillThroughInstance. And set the type be org.eclipse.birt.report.engine.content.IHyperlinkAction.ACTION_DRILLTHROUGH Throw IllegalArgumentException if the drillThroughInstance be set to null.- Parameters:
drillThroughInstance-
-
setTooltip
void setTooltip(java.lang.String tooltip)
-
getTooltip
java.lang.String getTooltip()
-
-