org.jppf.ui.options
Class OptionPanel

java.lang.Object
  org.jppf.ui.options.AbstractOptionProperties
      org.jppf.ui.options.AbstractOptionElement
          org.jppf.ui.options.OptionPanel

All Implemented Interfaces:

Serializable, OptionElement, OptionProperties, OptionsPage

public class OptionPanel
extends AbstractOptionElement
implements OptionsPage

Instances of this page represent dynamic UI components representing a page (or panel) container, with the underlying Swing component being a JPanel.
It also implements a specific behavior for radio buttons: any radio button that is a direct child is also added to a ButtonGroup.

Author:

Laurent Cohen

See Also:

Serialized Form

Field Summary

protected ButtonGroup	buttonGroup An eventual button group to which any radio button direct child is added.
protected List<OptionElement>	children The list of children of this options page.
protected JPanel	panel The panel used to display this options page.

Fields inherited from class org.jppf.ui.options.AbstractOptionElement

parent, root

Fields inherited from class org.jppf.ui.options.AbstractOptionProperties

bordered, componentConstraints, eventsEnabled, finalizer, iconPath, initializer, label, layoutConstraints, name, scripts, scrollable, toolTipText, UIComponent

Constructor Summary

OptionPanel()
Constructor provided as a convenience to facilitate the creation of option elements through reflexion.

OptionPanel(String name, String label, boolean scrollable)
Initialize this option page with the specified parameters, setting up a page without border.

OptionPanel(String name, String label, boolean scrollable, boolean bordered)
Initialize this option page with the specified parameters.

Method Summary

void	add(OptionElement element) Add an element to this options page.
void	createUI() Initialize the panel used to display this options page.
List<OptionElement>	getChildren() Get the options in this page.
void	remove(OptionElement element) Remove an element from this options page.
void	setEnabled(boolean enabled) Enable or disable this option.
void	setEventsEnabled(boolean enabled) Enable or disable the events firing in this option and/or its children.

Methods inherited from class org.jppf.ui.options.AbstractOptionElement

findAll, findAllWithName, findElement, findFirstWithName, findLastWithName, getChildForName, getParent, getPath, getRoot, getStringPath, setParent, toString

Methods inherited from class org.jppf.ui.options.AbstractOptionProperties

getComponentConstraints, getFinalizer, getIconPath, getInitializer, getLabel, getLayoutConstraints, getName, getScripts, getToolTipText, getUIComponent, isBordered, isEventsEnabled, isScrollable, setBordered, setComponentConstraints, setEditable, setFinalizer, setIconPath, setInitializer, setLabel, setLayoutConstraints, setName, setScrollable, setToolTipText, setUIComponent

Methods inherited from class java.lang.Object

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

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

findAllWithName, findElement, findFirstWithName, findLastWithName, getParent, getPath, getRoot, getStringPath

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

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

Field Detail

children

protected List<OptionElement> children

The list of children of this options page.

panel

protected JPanel panel

The panel used to display this options page.

buttonGroup

protected ButtonGroup buttonGroup

An eventual button group to which any radio button direct child is added.

Constructor Detail

OptionPanel

public OptionPanel()

Constructor provided as a convenience to facilitate the creation of option elements through reflexion.

OptionPanel

public OptionPanel(String name,
                   String label,
                   boolean scrollable,
                   boolean bordered)

Initialize this option page with the specified parameters.

Parameters:

name - this component's name.

label - the panel's title.

scrollable - determines whether this page should be enclosed within a scroll pane.

bordered - determines whether this page has a border around it.

OptionPanel

public OptionPanel(String name,
                   String label,
                   boolean scrollable)

Initialize this option page with the specified parameters, setting up a page without border. This constructor is used for building outermost pages.

Parameters:

name - this component's name.

label - the panel's title.

scrollable - determines whether this page should be enclosed within a scroll pane.

Method Detail

createUI

public void createUI()

Initialize the panel used to display this options page.

Specified by:

createUI in class AbstractOptionProperties

getChildren

public List<OptionElement> getChildren()

Get the options in this page.

Specified by:

getChildren in interface OptionsPage

Returns:

a list of Option instances.

See Also:

OptionsPage.getChildren()

add

public void add(OptionElement element)

Add an element to this options page. The element can be either an option, or another page.

Specified by:

add in interface OptionsPage

Parameters:

element - the element to add.

See Also:

OptionsPage.add(org.jppf.ui.options.OptionElement)

remove

public void remove(OptionElement element)

Remove an element from this options page.

Specified by:

remove in interface OptionsPage

Parameters:

element - the element to remove.

See Also:

OptionsPage.remove(org.jppf.ui.options.OptionElement)

setEnabled

public void setEnabled(boolean enabled)

Enable or disable this option.

Specified by:

setEnabled in interface OptionProperties

Parameters:

enabled - true to enable this option, false to disable it.

See Also:

OptionProperties.setEnabled(boolean)

setEventsEnabled

public void setEventsEnabled(boolean enabled)

Enable or disable the events firing in this option and/or its children.

Specified by:

setEventsEnabled in interface OptionProperties

Overrides:

setEventsEnabled in class AbstractOptionProperties

Parameters:

enabled - true to enable the events, false to disable them.

See Also:

OptionProperties.setEventsEnabled(boolean)