|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.Action
public class Action
The Action structure defines a hyperlink. There are five major kinds of actions:
The drill-through link can link to an existing report, or request to run a new report. It can optionally include:
The Hyperlink property returns a standard web-style link with ��http:�� or ��mailto:�� prefix. Expression hyperlinks can include special BIRT features (search and so on), but only as encoded into a URL. If the link wants to jump to a specific target within the document, encode that target within the URL as defined by target document type. (For example: http://foo.com/docs/myDoc.html#myTarget.) If the user provides a relative URL, it is assumed to be relative to the same web server that is being used to view the report. The exact semantics are implementation-specific in the open source release. In the commercial release, the URL is relative to the web server that hosts ActivePortal. A bookmark link simply identifies a bookmark identified within this report. Use the Bookmark property of a report item to create the target bookmark.
Field Summary | |
---|---|
static java.lang.String |
ACTION_STRUCT
Name of this structure. |
static java.lang.String |
FORMAT_TYPE_MEMBER
Property name of format. |
static java.lang.String |
LINK_TYPE_MEMBER
Link type of the Action. |
static java.lang.String |
PARAM_BINDINGS_MEMBER
Property name of parameter bindings, when this action is drill-through action. |
static java.lang.String |
REPORT_NAME_MEMBER
Property name of report name, when this action is drill-through action. |
static java.lang.String |
SEARCH_MEMBER
Property name of search, when this action is drill-through action. |
static java.lang.String |
TARGET_BOOKMARK_MEMBER
Property name of the target bookmark link. |
static java.lang.String |
TARGET_BOOKMARK_TYPE_MEMBER
Property name of target bookmark type. |
static java.lang.String |
TARGET_FILE_TYPE_MEMBER
Property name of target type of linked file. |
static java.lang.String |
TARGET_WINDOW_MEMBER
Property name of the target browser window for the link. |
static java.lang.String |
TOOLTIP_MEMBER
Property name of the tool tip. |
static java.lang.String |
URI_MEMBER
Property name of the hyperlink. |
Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
---|
propValues |
Constructor Summary | |
---|---|
Action()
|
Method Summary | |
---|---|
StructureHandle |
getHandle(SimpleValueHandle valueHandle)
|
java.lang.String |
getStructName()
Returns the name of the structure definition. |
protected StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
|
Methods inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
---|
clone, getIntrinsicProperty, getLocalProperty, getLocalProperty, setIntrinsicProperty, setProperty |
Methods inherited from class org.eclipse.birt.report.model.core.Structure |
---|
copy, equals, getContext, getDefn, getElement, getHandle, getListMemberRef, getObjectDefn, getProperty, getProperty, getReferencableProperty, isDesignTime, isReferencable, setContext, setProperty, updateReference, validate |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ACTION_STRUCT
public static final java.lang.String URI_MEMBER
public static final java.lang.String REPORT_NAME_MEMBER
public static final java.lang.String LINK_TYPE_MEMBER
public static final java.lang.String TARGET_WINDOW_MEMBER
public static final java.lang.String TOOLTIP_MEMBER
public static final java.lang.String TARGET_BOOKMARK_MEMBER
public static final java.lang.String PARAM_BINDINGS_MEMBER
public static final java.lang.String SEARCH_MEMBER
public static final java.lang.String FORMAT_TYPE_MEMBER
public static final java.lang.String TARGET_FILE_TYPE_MEMBER
public static final java.lang.String TARGET_BOOKMARK_TYPE_MEMBER
Constructor Detail |
---|
public Action()
Method Detail |
---|
public java.lang.String getStructName()
IStructure
protected StructureHandle handle(SimpleValueHandle valueHandle, int index)
handle
in class org.eclipse.birt.report.model.core.Structure
public StructureHandle getHandle(SimpleValueHandle valueHandle)
getHandle
in class org.eclipse.birt.report.model.core.Structure
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |