org.eclipse.birt.report.engine.api.script.instance
Interface IActionInstance


public interface IActionInstance


Method Summary
 IDrillThroughInstance createDrillThrough()
          create a empty drillThrough instance.
 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:
 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.
 java.lang.String getBookmark()
           
 IDrillThroughInstance getDrillThrough()
           
 java.lang.String getHyperlink()
           
 java.lang.String getTargetWindow()
           
 int getType()
           
 void setBookmark(java.lang.String bookmark)
          Set bookmark.
 void setDrillThrough(IDrillThroughInstance drillThroughInstance)
          Set IDrillThroughInstance.
 void setHyperlink(java.lang.String hyperlink, java.lang.String target)
          Set hyperlink string and target.
 

Method Detail

getType

public 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

public java.lang.String getBookmark()
Returns:
the bookmark string when action type is bookmark. Otherwise, throw RuntimeException.

setBookmark

public 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

public java.lang.String getHyperlink()
Returns:
the action string when action type is hyperlink. Otherwise, throw RuntimeException.

setHyperlink

public 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

public java.lang.String getTargetWindow()
Returns:
The name of a frame where a target hyperlink or drillThrough to be opened.

createDrillThrough

public 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

public 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

public IDrillThroughInstance createDrillThrough()
create a empty drillThrough instance.

Returns:

getDrillThrough

public IDrillThroughInstance getDrillThrough()
Returns:
the drillThrouthInstance when action type is drillThrough. Otherwise, throw RuntimeException.

setDrillThrough

public 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 -


Copyright © 2005 Actuate Corp. All rights reserved.