Package org.jppf.ui.options

Interface OptionElement

All Superinterfaces:
OptionProperties, Serializable
All Known Subinterfaces:
Option, OptionContainer
All Known Implementing Classes:
AbstractOption, AbstractOptionContainer, AbstractOptionElement, AbstractTreeTableOption, BooleanOption, ButtonOption, CodeEditorOption, ComboBoxOption, FileChooserOption, FillerOption, FormattedNumberOption, GraphOption, JavaOption, JobDataPanel, JVMHealthPanel, LabelOption, ListOption, NodeDataPanel, OptionPanel, PasswordOption, PickListOption, PlainTextOption, PluggableViewOption, 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 Details

    • getRoot

      OptionElement getRoot()
      Get the root of the option tree this option belongs to.
      Returns:
      a OptionElement instance.

    • getParent

      OptionElement getParent()
      Get the parent page for this options page.
      Returns:
      an OptionsPage 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 separated 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 specified 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 specified 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 specified 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.