org.jppf.ui.options
Interface OptionElement

All Superinterfaces:

OptionProperties, Serializable

All Known Subinterfaces:

Option, OptionsPage

All Known Implementing Classes:

AbstractOption, AbstractOptionElement, AbstractTreeTableOption, BooleanOption, ButtonOption, ComboBoxOption, FileChooserOption, FillerOption, FormattedNumberOption, JavaOption, JobDataPanel, LabelOption, ListOption, NodeDataPanel, OptionPanel, PasswordOption, PlainTextOption, RadioButtonOption, SpinnerNumberOption, SplitPaneOption, TabbedPaneOption, TextAreaOption, TextOption, ToolbarOption, ToolbarSeparatorOption

public interface OptionElement
extends OptionProperties

Base interface for all UI components dynamically created from XML descriptors.

Author:

Laurent Cohen

Method Summary

List<OptionElement>	findAllWithName(String name) Find all the elements with the specified name in the subtree of which this element is the root.
OptionElement	findElement(String path) Find the element with the specified path in the options tree.
OptionElement	findFirstWithName(String name) Find the first element with the specified name in the subtree of which this element is the root.
OptionElement	findLastWithName(String name) Find the last element with the specified name in the subtree of which this element is the root.
OptionElement	getParent() Get the parent page for this options page.
TreePath	getPath() Get the path of this element in the option tree.
OptionElement	getRoot() Get the root of the option tree this option belongs to.
String	getStringPath() Get the path of this element in the option tree, represented as a string.

Methods inherited from interface org.jppf.ui.options.OptionProperties

getComponentConstraints, getFinalizer, getIconPath, getInitializer, getLabel, getLayoutConstraints, getName, getScripts, getToolTipText, getUIComponent, isBordered, isEventsEnabled, isScrollable, setComponentConstraints, setEditable, setEnabled, setEventsEnabled, setLayoutConstraints

Method Detail

getParent

OptionElement getParent()

Get the parent page for this options page.

Returns:

an OptionsPage instance.

getRoot

OptionElement getRoot()

Get the root of the option tree this option belongs to.

Specified by:

getRoot in interface OptionProperties

Returns:

a OptionElement instance.

getPath

TreePath getPath()

Get the path of this element in the option tree.

Returns:

a TreePath whose components are OptionElement instances.

getStringPath

String getStringPath()

Get the path of this element in the option tree, represented as a string. The string path is a sequence of element names separted by slashes.

Returns:

a TreePath whose components are OptionElement instances.

findFirstWithName

OptionElement findFirstWithName(String name)

Find the first element with the specified name in the subtree of which this element is the root. The notion of first element relates to a depth-first search in the tree.

Parameters:

name - the name of the element to find.

Returns:

an OptionElement instance, or null if no element could be found with the specfied name.

findLastWithName

OptionElement findLastWithName(String name)

Find the last element with the specified name in the subtree of which this element is the root. The notion of last element relates to a depth-first search in the tree.

Parameters:

name - the name of the element to find.

Returns:

an OptionElement instance, or null if no element could be found with the specfied name.

findAllWithName

List<OptionElement> findAllWithName(String name)

Find all the elements with the specified name in the subtree of which this element is the root.

Parameters:

name - the name of the elements to find.

Returns:

a list of OptionElement instances, or null if no element could be found with the specfied name.

findElement

OptionElement findElement(String path)

Find the element with the specified path in the options tree. The path can be absolute, in which case it starts with a "/", otherwise it is considered relative to the requesting element.

Parameters:

path - the path of the element to find.

Returns:

an OptionElement instance, or null if no element could be found with the specified path.