Package io.guise.framework.component.widget

Interface Widget

  • All Superinterfaces:
    Component, DepictedObject, Displayable, InfoModel, LabelModel, Model, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable
    public interface Widget
extends Component
    A component that can be embedded in certain content and can be edited within a widget editing environment. Widgets must provide a default constructor. A widget may also provide a two-URI constructor that allows specification of the base URI where the widget is embedded, as well as the URI of the definition of the widget, such as a template, either of which may be null.
    Author:
    Garret Wilson

    • Field Detail

      • WIDGET_CONTENT_TYPE

        static final com.globalmentor.net.ContentType WIDGET_CONTENT_TYPE
        The MIME type of a Guise widget.

    • Method Detail

      • getBaseURI

        java.net.URI getBaseURI()
        Returns the base URI where the widget is embedded.
        Returns:
        The base URI where the widget is embedded, or null if the base URI is not known.

      • getDefinitionBaseURI

        java.net.URI getDefinitionBaseURI()
        Returns the base URI of the definition of the widget. This may be the URI of a template resource, allowing the true base URI of the widget to vary based upon the instance resource with which the resource is used.
        Returns:
        The base URI of the definition of the widget, or null if the definition base URI is not known.

      • getParameterNames

        java.util.Set<java.lang.String> getParameterNames()
        Retrieves that names of parameters that are allowed to be accessed in a widget context.
        Returns:
        The set of names of widget parameters.