Skip navigation links

oracle.javatools.ui.checklist
Class ContentElement

java.lang.Object
oracle.javatools.ui.checklist.ContentElement

public final class ContentElement

extends java.lang.Object

ContentElement are the user-interactable elements that appear within the StepContents like an action button that triggers an action or opens a dialog, or a hyperlink that opens the link in browser or help dialog, etc., Clients can specify the label, icon and id for each element. The target is the target action ID or target link for this ContentElement. HintText is the description for the ContentElement which will be displayed at the bottom of the ContentElement. HintText can also be used to specify other information about the ContentElements. For example, clients can specify the alternative menu path in the application to trigger the action represented by ACTIONBUTTON ContentElement by providing comma separated menus as thje hintText.

Nested Class Summary

static class

ContentElement.Type Specifies the type of ContentElement.

Constructor Summary

ContentElement(java.lang.String id, ContentElement.Type type, java.lang.String target)
Creates a ContentElement with specified parameters.

ContentElement(java.lang.String id, ContentElement.Type type, java.lang.String label, javax.swing.Icon icon, java.lang.String target)
Creates a ContentElement with specified parameters.

ContentElement(java.lang.String id, ContentElement.Type type, java.lang.String label, javax.swing.Icon icon, java.lang.String target, java.lang.String hint)
Creates a ContentElement with specified parameters.

ContentElement(java.lang.String id, ContentElement.Type type, java.lang.String label, java.lang.String target)
Creates a ContentElement with specified parameters.

Method Summary

java.lang.String	getHint() Returns the HintText (or description) of the content element.
javax.swing.Icon	getIcon() Returns the icon for the content element.
java.lang.String	getId() Returns the id of the ContentElement.
java.lang.String	getLabel() Returns the label of the ContentElement.
java.lang.String	getTarget() Returns the target of the ContentElement.
ContentElement.Type	getType() Returns the type of the ContentElement.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentElement

public ContentElement(java.lang.String id,
                      ContentElement.Type type,
                      java.lang.String target)

Creates a ContentElement with specified parameters.

ContentElement

public ContentElement(java.lang.String id,
                      ContentElement.Type type,
                      java.lang.String label,
                      java.lang.String target)

Creates a ContentElement with specified parameters.

ContentElement

public ContentElement(java.lang.String id,
                      ContentElement.Type type,
                      java.lang.String label,
                      javax.swing.Icon icon,
                      java.lang.String target)

Creates a ContentElement with specified parameters.

ContentElement

public ContentElement(java.lang.String id,
                      ContentElement.Type type,
                      java.lang.String label,
                      javax.swing.Icon icon,
                      java.lang.String target,
                      java.lang.String hint)

Creates a ContentElement with specified parameters.

Method Detail

getId

public java.lang.String getId()

Returns the id of the ContentElement.

getType

public ContentElement.Type getType()

Returns the type of the ContentElement.

getLabel

public java.lang.String getLabel()

Returns the label of the ContentElement.

getTarget

public java.lang.String getTarget()

Returns the target of the ContentElement. The target could be any linkTarget or the target id for the action.

getIcon

public javax.swing.Icon getIcon()

Returns the icon for the content element.

getHint

public java.lang.String getHint()

Returns the HintText (or description) of the content element.

Skip navigation links