Package org.jppf.ui.options

Interface OptionProperties

All Superinterfaces:
Serializable
All Known Subinterfaces:
Option, OptionContainer, OptionElement
All Known Implementing Classes:
AbstractOption, AbstractOptionContainer, AbstractOptionElement, AbstractOptionProperties, 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 OptionProperties extends Serializable
Base interface for all UI components dynamically created from XML descriptors.
Author:
Laurent Cohen

  • Method Details

    • getName

      String getName()
      Get the name of this options page.
      Returns:
      the name as a string.

    • getLabel

      String getLabel()
      Get the title of this element. The title can be the title for a panel or a label associated with an option.
      Returns:
      the title as a string.

    • getToolTipText

      String getToolTipText()
      The tooltip text displayed with the UI component.
      Returns:
      the tooltip as a string.

    • setEnabled

      void setEnabled(boolean enabled)
      Enable or disable this option.
      Parameters:
      enabled - true to enable this option, false to disable it.

    • setEditable

      void setEditable(boolean editable)
      Enable or disable this option.
      Parameters:
      editable - true to make this option editable, false otherwise.

    • isEventsEnabled

      boolean isEventsEnabled()
      Determine whether the events firing in this option and/or its children are enabled.
      Returns:
      enabled true if the events are enabled, false otherwise.

    • setEventsEnabled

      void setEventsEnabled(boolean enabled)
      Enable or disable the events firing in this option and/or its children.
      Parameters:
      enabled - true to enable the events, false to disable them.

    • isScrollable

      boolean isScrollable()
      Determine whether this page should be enclosed within a scroll pane.
      Returns:
      true if the page is to be enclosed in a scroll pane, false otherwise.

    • isBordered

      boolean isBordered()
      Determine whether this page has a border around it.
      Returns:
      true if the page has a border, false otherwise.

    • getUIComponent

      JComponent getUIComponent()
      Get the UI component for this option.
      Returns:
      a JComponent instance.

    • getScripts

      List<OptionDescriptor.ScriptDescriptor> getScripts()
      Get the scripts used by this option or its children.
      Returns:
      a list of ScriptDescriptor instances.

    • getInitializer

      ValueChangeListener getInitializer()
      Get the action to fire immediately after the page is built, allowing to perform initializations before the page is displayed and used.
      Returns:
      a ValueChangeListener instance.

    • getFinalizer

      ValueChangeListener getFinalizer()
      Get the action to fire immediately when the page is disposed.
      Returns:
      a ValueChangeListener instance.

    • getIconPath

      String getIconPath()
      Get the path to an eventual icon displayed in the button.
      Returns:
      the path as a string.

    • getLayoutConstraints

      String getLayoutConstraints()
      Get the Mig layout constraints for the entire layout.
      Returns:
      the constraints as a string.

    • setLayoutConstraints

      void setLayoutConstraints(String layoutConstraints)
      Set the Mig layout constraints for the entire layout.
      Parameters:
      layoutConstraints - the constraints as a string.

    • getComponentConstraints

      String getComponentConstraints()
      Get the Mig layout constraints for a component.
      Returns:
      the constraints as a string.

    • setComponentConstraints

      void setComponentConstraints(String componentConstraints)
      Set the Mig layout constraints for a component.
      Parameters:
      componentConstraints - the constraints as a string.

    • isDetachable

      boolean isDetachable()
      Determines whether this component can be detached to a different view.
      Returns:
      true if this component can be detached, false otherwise.

    • getMouseListener

      MouseListener getMouseListener()
      Get the Java or scripted mouse click listener.
      Returns:
      a MouseListener instance.

    • setMouseListener

      void setMouseListener(MouseListener mouseListener)
      Set the Java or scripted mouse click listener.
      Parameters:
      mouseListener - a MouseListener instance.