com.inductiveautomation.ignition.gateway.model

Class AbstractHomepagePanelDescriptor

java.lang.Object

com.inductiveautomation.ignition.gateway.model.AbstractHomepagePanelDescriptor

All Implemented Interfaces:

IHomepagePanelDescriptor

public abstract class AbstractHomepagePanelDescriptor
extends java.lang.Object
implements IHomepagePanelDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initiallyExpanded
protected int	order
protected java.lang.String	panelName A unique identifying name for this panel.
protected java.lang.String	titleResourceKey
protected boolean	visible

Constructor Summary

Constructors

Constructor and Description
AbstractHomepagePanelDescriptor(java.lang.String panelName, java.lang.String titleResourceKey, int suggestedOrder)

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() Deprecated.
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?
abstract org.apache.wicket.markup.html.panel.Panel	newPanel(java.lang.String id) Create the new panel to display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.IHomepagePanelDescriptor

getSearchableItems

Field Detail

panelName

protected java.lang.String panelName

A unique identifying name for this panel. Used to track the panel as the user reorders them and chooses to not display some panels.

order

protected int order

titleResourceKey

protected java.lang.String titleResourceKey

initiallyExpanded

protected boolean initiallyExpanded

visible

protected boolean visible

Constructor Detail

AbstractHomepagePanelDescriptor

public AbstractHomepagePanelDescriptor(java.lang.String panelName,
                                       java.lang.String titleResourceKey,
                                       int suggestedOrder)

Method Detail

getPanelName

public java.lang.String getPanelName()

Description copied from interface: IHomepagePanelDescriptor

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

Specified by:

getPanelName in interface IHomepagePanelDescriptor

getOrder

public int getOrder()

Description copied from interface: IHomepagePanelDescriptor

A relative ordering for this panel. Lower numbers appear first.

Specified by:

getOrder in interface IHomepagePanelDescriptor

getTitleResourceKey

public java.lang.String getTitleResourceKey()

Description copied from interface: IHomepagePanelDescriptor

A resource key to use as the panel title.

Specified by:

getTitleResourceKey in interface IHomepagePanelDescriptor

isInitiallyExpanded

public boolean isInitiallyExpanded()

Description copied from interface: IHomepagePanelDescriptor

Should this panel be initially expanded or collapsed?

Specified by:

isInitiallyExpanded in interface IHomepagePanelDescriptor

newPanel

public abstract org.apache.wicket.markup.html.panel.Panel newPanel(java.lang.String id)

Description copied from interface: IHomepagePanelDescriptor

Create the new panel to display.

Specified by:

newPanel in interface IHomepagePanelDescriptor

isVisible

public boolean isVisible()

Description copied from interface: IHomepagePanelDescriptor

Is this homepage visible?

Specified by:

isVisible in interface IHomepagePanelDescriptor

getHelpResourceKey

public java.lang.String getHelpResourceKey()

Description copied from interface: IHomepagePanelDescriptor

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

Specified by:

getHelpResourceKey in interface IHomepagePanelDescriptor

getHelpTopicId

@Deprecated
public java.lang.String getHelpTopicId()

Deprecated.

Description copied from interface: IHomepagePanelDescriptor

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>
 

Specified by:

getHelpTopicId in interface IHomepagePanelDescriptor