Package com.inductiveautomation.ignition.gateway.model

Interface IHomepagePanelDescriptor

All Known Implementing Classes:
AbstractHomepagePanelDescriptor
public interface IHomepagePanelDescriptor

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHelpResourceKey()
    Return the resource key for the panel's help blurb.
    String
    getHelpTopicId()
    Deprecated.
    This method will no longer exist in future versions.
    int
    getOrder()
    A relative ordering for this panel.
    String
    getPanelName()
    A unique name for this panel.
    default Iterable<String>
    getSearchableItems()
    Return a list of names of items that will appear within this homepage panel that should show up in the site-wide search
    String
    getTitleResourceKey()
    A resource key to use as the panel title.
    boolean
    isInitiallyExpanded()
    Should this panel be initially expanded or collapsed?
    boolean
    isVisible()
    Is this homepage visible?
    org.apache.wicket.markup.html.panel.Panel
    newPanel(String id)
    Create the new panel to display.

  • Method Details

    • getPanelName

      String getPanelName()
      A unique name for this panel. Used as a key to store preferences for the user to override this panel's settings.

    • getOrder

      int getOrder()
      A relative ordering for this panel. Lower numbers appear first.

    • getTitleResourceKey

      String getTitleResourceKey()
      A resource key to use as the panel title.

    • isInitiallyExpanded

      boolean isInitiallyExpanded()
      Should this panel be initially expanded or collapsed?

    • newPanel

      org.apache.wicket.markup.html.panel.Panel newPanel(String id)
      Create the new panel to display.

    • isVisible

      boolean isVisible()
      Is this homepage visible?

    • getHelpResourceKey

      String getHelpResourceKey()
      Return the resource key for the panel's help blurb.

    • getHelpTopicId

      @Deprecated String getHelpTopicId()
      Deprecated.
      This method will no longer exist in future versions.
      Return the name of the user manual topic to link to. The string ${HELP} will be replaced to a url to this help topic if found in the content pointed to by the help resource key. For example, the help blurb might be: 

       This panel is great. You should use it lots. <a href="${HELP}">Learn more...</a>

    • getSearchableItems

      default Iterable<String> getSearchableItems()
      Return a list of names of items that will appear within this homepage panel that should show up in the site-wide search