Package ptolemy.vergil.basic.export.web

Class IconLink

  • All Implemented Interfaces:
    java.lang.Cloneable, HasTypeConstraints, Typeable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable, ValueListener, WebExportable
    Direct Known Subclasses:
    DefaultIconLink
    public class IconLink
extends WebContent
implements WebExportable
    Attribute specifying a URI to link to from an icon when a model is exported to a web page. Using the linkTarget parameter, you can control how the link is displayed. In contrast, LiveLink provides a link to a model in Vergil (instead of in an exported web page).

    To use this, drag it onto an icon in your model. Then double click on that icon to set the URL to link to. The linkTarget parameter specifies whether the link should be opened in a new browser window (the default), in the same browser window, in a lightbox, etc.

    Note that this attribute can be used in combination with LinkToOpenTableaux. The latter provides a hyperlink that works within Vergil, whereas this attribute provides a hyperlink that works in an exported HTML page. For example, LinkToOpenTableaux might be used to provide a hyperlink to another model (a pointer to its MoML file), so that double clicking on the container of the LiveLink attribute opens the other model. If that container also contains an instance of IconLink, then when the model is exported to a web page, the container's icon can become a link to the exported page for the other model.

    Since:
    Ptolemy II 10.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (cxh)

    • Field Detail

      • linkTarget

        public LinkTarget linkTarget
        Parameter specifying the target for the link. The possibilities are:
        • _lightbox: Open in a lightbox-style popup frame.
        • _blank: Open in a new window or tab.
        • _self: Open in the same frame as it was clicked.
        • _parent: Open in the parent frameset.
        • _top: Open in the full body of the window.
        • framename: Open in a named frame.
        The default is "_lightbox".

    • Method Detail

      • getMimeType

        public java.lang.String getMimeType()
        A link is of type text/html.
        Specified by:
        getMimeType in interface WebExportable
        Returns:
        The string text/html

      • isOverwriteable

        public boolean isOverwriteable()
        Return true, since new content should overwrite old.
        Specified by:
        isOverwriteable in interface WebExportable
        Returns:
        True, since new content should overwrite old

      • _provideAttributes

        protected void _provideAttributes​(WebExporter exporter)
                           throws IllegalActionException
        Provide content to the specified web exporter to be included in a web page for the container of this object. This class defines an href attribute to associate with the area of the image map corresponding to its container.
        Overrides:
        _provideAttributes in class WebContent
        Parameters:
        exporter - The web exporter to write content to
        Throws:
        IllegalActionException - If evaluating the value of this parameter fails, or creating a web attribute fails.