com.inductiveautomation.ignition.gateway.model

Interface IHomepagePanelDescriptor

All Known Implementing Classes:

AbstractHomepagePanelDescriptor

public interface IHomepagePanelDescriptor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHelpResourceKey() Return the resource key for the panel's help blurb.
java.lang.String	getHelpTopicId() Return the name of the user manual topic to link to.
int	getOrder() A relative ordering for this panel.
java.lang.String	getPanelName() A unique name for this panel.
java.lang.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(java.lang.String id) Create the new panel to display.

Method Detail

getPanelName

java.lang.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

java.lang.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(java.lang.String id)

Create the new panel to display.

isVisible

boolean isVisible()

Is this homepage visible?

getHelpResourceKey

java.lang.String getHelpResourceKey()

Return the resource key for the panel's help blurb.

getHelpTopicId

java.lang.String getHelpTopicId()

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>