Interface ContentQueryAction

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getHtml()
      Returns an encoded HTML fragment representing the action, typically in the form of a complete <a>-tag.
      String getLabel()
      Returns the label of the action.
      String getOnclick()
      Returns a javascript event handler suitable for use as the "onclick" attribute in an <a>-tag.
      String getScript()
      Returns a javascript fragment used to activate the action.
      String getUrl()
      Returns the URL of the action, usable as the "href" attribute in an <a>-tag.
    • Method Detail

      • getLabel

        String getLabel()
        Returns the label of the action. The label is not encoded, and may need encoding before use.
        Returns:
        the label of the action
      • getUrl

        String getUrl()
        Returns the URL of the action, usable as the "href" attribute in an <a>-tag.
        Returns:
        the URL of the action
      • getOnclick

        String getOnclick()
        Returns a javascript event handler suitable for use as the "onclick" attribute in an <a>-tag. Unlike getScript(), the value is only usable in an "onclick" attribute, and may use this constraint to create a shorter script reference.
        Returns:
        javascript event handler
      • getScript

        String getScript()
        Returns a javascript fragment used to activate the action. Unlike getOnclick(), the script fragment is not constrained to be used in an <a>-tag; it may therefore be a longer fragment, but it will also contain all require information.
        Returns:
        javascript fragment
      • getHtml

        String getHtml()
        Returns an encoded HTML fragment representing the action, typically in the form of a complete <a>-tag.
        Specified by:
        getHtml in interface HtmlProvider
        Returns:
        an encoded HTML fragment representing the action