Class Action

  • All Implemented Interfaces:
    java.lang.Cloneable, IStructure, org.eclipse.birt.report.model.core.IPropertySet

    public class Action
    extends org.eclipse.birt.report.model.core.PropertyStructure
    The Action structure defines a hyperlink. There are five major kinds of actions:
    • Hyperlink: To an external web site, e-mail system, etc.
    • Bookmark Link: To a location within this report as specified by a bookmark.
    • Drill-through: To a location within another report as specified by a bookmark.

    The drill-through link can link to an existing report, or request to run a new report. It can optionally include:

    • Parameters to pass when creating a new report.
    • A location within the target report as specified by a search.
    • A location within the target report as specified by a bookmark.

    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.