org.jppf.ui.options
Class SplitPaneOption

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

All Implemented Interfaces:

Serializable, OptionElement, OptionProperties, OptionsPage

public class SplitPaneOption
extends AbstractOptionElement
implements OptionsPage

This option class encapsulates a split pane, as the one present in the Swing api.

Author:

Laurent Cohen

See Also:

Serialized Form

Field Summary

protected List<OptionElement>	children The list of children of this options page.
protected int	dividerWidth The split pane's divider width.
protected Option	FILLER1 Used when nothing is set in the left (top) panel.
protected Option	FILLER2 Used when nothing is set in the right (bottom) panel.
static int	HORIZONTAL Horizontal split.
protected int	orientation The orientation of the split, one of VERTICAL or HORIZONTAL.
protected double	resizeWeight The split pane's resize weight.
static int	VERTICAL Vertical split.

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

SplitPaneOption()
Initialize the split pane with 2 fillers as left (or top) and right (or bottom) components.

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.
int	getDividerWidth() Get the split pane's divider width.
int	getOrientation() Get the orientation of the split.
double	getResizeWeight() Get the split pane's resize weight.
void	remove(OptionElement element) Remove an element from this options page.
void	setDividerWidth(int dividerWidth) Set the split pane's divider width.
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.
void	setOrientation(int orientation) Set the orientation of the split.
void	setResizeWeight(double resizeWeight) Set the split pane's resize weight.

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

HORIZONTAL

public static final int HORIZONTAL

Horizontal split.

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

Vertical split.

See Also:

Constant Field Values

FILLER1

protected final Option FILLER1

Used when nothing is set in the left (top) panel.

FILLER2

protected final Option FILLER2

Used when nothing is set in the right (bottom) panel.

children

protected List<OptionElement> children

The list of children of this options page.

resizeWeight

protected double resizeWeight

The split pane's resize weight.

dividerWidth

protected int dividerWidth

The split pane's divider width.

orientation

protected int orientation

The orientation of the split, one of VERTICAL or HORIZONTAL.

Constructor Detail

SplitPaneOption

public SplitPaneOption()

Initialize the split pane with 2 fillers as left (or top) and right (or bottom) components.

Method Detail

createUI

public void createUI()

Initialize the panel used to display this options page.

Specified by:

createUI in class AbstractOptionProperties

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)

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)

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()

getDividerWidth

public int getDividerWidth()

Get the split pane's divider width.

Returns:

the divider width as an int value.

setDividerWidth

public void setDividerWidth(int dividerWidth)

Set the split pane's divider width.

Parameters:

dividerWidth - the divider width as an int value.

getResizeWeight

public double getResizeWeight()

Get the split pane's resize weight.

Returns:

the resize weight as a double value.

setResizeWeight

public void setResizeWeight(double resizeWeight)

Set the split pane's resize weight.

Parameters:

resizeWeight - the resize weight as a double value.

getOrientation

public int getOrientation()

Get the orientation of the split.

Returns:

one of VERTICAL or HORIZONTAL.

setOrientation

public void setOrientation(int orientation)

Set the orientation of the split.

Parameters:

orientation - - one of VERTICAL or HORIZONTAL.