org.jminor.swing.common.ui.control

Class Controls

java.lang.Object

org.jminor.swing.common.ui.control.Controls

public final class Controls
extends java.lang.Object

A factory class for Control objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Controls.ToggleControl A Control for toggling a button model

Method Summary

Modifier and Type	Method and Description
static Control	control(Control.Command command) Creates a control based on a Control.Command
static Control	control(Control.Command command, javax.swing.Icon icon) Creates a control based on a Control.Command
static Control	control(Control.Command command, javax.swing.Icon icon, StateObserver enabledState) Creates a control based on a Control.Command
static Control	control(Control.Command command, java.lang.String name) Creates a control based on a Control.Command
static Control	control(Control.Command command, java.lang.String name, StateObserver enabledState) Creates a control based on a Control.Command
static Control	control(Control.Command command, java.lang.String name, StateObserver enabledState, java.lang.String description) Creates a control based on a Control.Command
static Control	control(Control.Command command, java.lang.String name, StateObserver enabledState, java.lang.String description, int mnemonic) Creates a control based on a Control.Command
static Control	control(Control.Command command, java.lang.String name, StateObserver enabledState, java.lang.String description, int mnemonic, javax.swing.KeyStroke keyStroke) Creates a control based on a Control.Command
static Control	control(Control.Command command, java.lang.String name, StateObserver enabledState, java.lang.String description, int mnemonic, javax.swing.KeyStroke keyStroke, javax.swing.Icon icon) Creates a control based on a Control.Command
static Control	eventControl(Event<java.awt.event.ActionEvent> event) Creates a Control which fires the given event on action performed
static Controls.ToggleControl	toggleControl(java.lang.Object owner, java.lang.String beanPropertyName, java.lang.String caption) Creates a toggle control based on the boolean property beanPropertyName in the owner object
static Controls.ToggleControl	toggleControl(java.lang.Object owner, java.lang.String beanPropertyName, java.lang.String caption, EventObserver<java.lang.Boolean> changeEvent) Creates a toggle control based on the boolean property beanPropertyName in the owner object
static Controls.ToggleControl	toggleControl(java.lang.Object owner, java.lang.String beanPropertyName, java.lang.String caption, EventObserver<java.lang.Boolean> changeEvent, StateObserver enabledState) Creates a toggle control based on the boolean property beanPropertyName in the owner object
static Controls.ToggleControl	toggleControl(java.lang.Object owner, java.lang.String beanPropertyName, java.lang.String caption, EventObserver<java.lang.Boolean> changeEvent, StateObserver enabledState, boolean tristate) Creates a toggle control based on the boolean property beanPropertyName in the owner object
static Controls.ToggleControl	toggleControl(State state) Creates a ToggleControl based on the given State
static Controls.ToggleControl	toggleControl(State state, java.lang.String name) Creates a ToggleControl based on the given State
static Controls.ToggleControl	toggleControl(State state, java.lang.String name, StateObserver enabledState) Creates a ToggleControl based on the given State
static Controls.ToggleControl	toggleControl(State state, java.lang.String name, StateObserver enabledState, javax.swing.Icon icon) Creates a ToggleControl based on the given State
static Controls.ToggleControl	toggleControl(Value<java.lang.Boolean> value) Creates a ToggleControl based on the given boolean Value.
static Controls.ToggleControl	toggleControl(Value<java.lang.Boolean> value, java.lang.String name) Creates a ToggleControl based on the given boolean Value If the value is nullable then a TristateButtonModel is used.
static Controls.ToggleControl	toggleControl(Value<java.lang.Boolean> value, java.lang.String name, StateObserver enabledState) Creates a ToggleControl based on the given boolean Value If the value is nullable then a TristateButtonModel is used.
static Controls.ToggleControl	toggleControl(Value<java.lang.Boolean> value, java.lang.String name, StateObserver enabledState, javax.swing.Icon icon) Creates a ToggleControl based on the given boolean Value If the value is nullable then a TristateButtonModel is used.

Methods inherited from class java.lang.Object

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

Method Detail

control

public static Control control(Control.Command command)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              javax.swing.Icon icon)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

icon - the icon

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              javax.swing.Icon icon,
                              StateObserver enabledState)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

icon - the icon

enabledState - the state which controls the enabled state of the control

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              java.lang.String name)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

name - the name of the control

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              java.lang.String name,
                              StateObserver enabledState)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

name - the name of the control

enabledState - the state which controls the enabled state of the control

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              java.lang.String name,
                              StateObserver enabledState,
                              java.lang.String description)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

name - the name of the control

enabledState - the state which controls the enabled state of the control

description - a string describing the control

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              java.lang.String name,
                              StateObserver enabledState,
                              java.lang.String description,
                              int mnemonic)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

name - the name of the control

enabledState - the state which controls the enabled state of the control

description - a string describing the control

mnemonic - the control mnemonic

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              java.lang.String name,
                              StateObserver enabledState,
                              java.lang.String description,
                              int mnemonic,
                              javax.swing.KeyStroke keyStroke)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

name - the name of the control

enabledState - the state which controls the enabled state of the control

description - a string describing the control

mnemonic - the control mnemonic

keyStroke - the keystroke to associate with the control

Returns:

a Control for calling the given Control.Command

control

public static Control control(Control.Command command,
                              java.lang.String name,
                              StateObserver enabledState,
                              java.lang.String description,
                              int mnemonic,
                              javax.swing.KeyStroke keyStroke,
                              javax.swing.Icon icon)

Creates a control based on a Control.Command

Parameters:

command - the Control.Command on which to base this control

name - the name of the control

enabledState - the state which controls the enabled state of the control

description - a string describing the control

mnemonic - the control mnemonic

keyStroke - the keystroke to associate with the control

icon - the control icon

Returns:

a Control for calling the given Control.Command

toggleControl

public static Controls.ToggleControl toggleControl(java.lang.Object owner,
                                                   java.lang.String beanPropertyName,
                                                   java.lang.String caption)

Creates a toggle control based on the boolean property beanPropertyName in the owner object

Parameters:

owner - the owner object

beanPropertyName - the name of the boolean bean property, must have a public setter and getter

caption - the control caption

Returns:

a toggle control

toggleControl

public static Controls.ToggleControl toggleControl(java.lang.Object owner,
                                                   java.lang.String beanPropertyName,
                                                   java.lang.String caption,
                                                   EventObserver<java.lang.Boolean> changeEvent)

Creates a toggle control based on the boolean property beanPropertyName in the owner object

Parameters:

owner - the owner object

beanPropertyName - the name of the boolean bean property, must have a public setter and getter

caption - the control caption

changeEvent - an event fired each time the property value changes in the underlying object

Returns:

a toggle control

toggleControl

public static Controls.ToggleControl toggleControl(java.lang.Object owner,
                                                   java.lang.String beanPropertyName,
                                                   java.lang.String caption,
                                                   EventObserver<java.lang.Boolean> changeEvent,
                                                   StateObserver enabledState)

Creates a toggle control based on the boolean property beanPropertyName in the owner object

Parameters:

owner - the owner object

beanPropertyName - the name of the boolean bean property, must have a public setter and getter

caption - the control caption

changeEvent - an event fired each time the property value changes in the underlying object

enabledState - the state which controls the enabled state of the control

Returns:

a toggle control

toggleControl

public static Controls.ToggleControl toggleControl(java.lang.Object owner,
                                                   java.lang.String beanPropertyName,
                                                   java.lang.String caption,
                                                   EventObserver<java.lang.Boolean> changeEvent,
                                                   StateObserver enabledState,
                                                   boolean tristate)

Creates a toggle control based on the boolean property beanPropertyName in the owner object

Parameters:

owner - the owner object

beanPropertyName - the name of the boolean bean property, must have a public setter and getter

caption - the control caption

changeEvent - an event fired each time the property value changes in the underlying object

enabledState - the state which controls the enabled state of the control

tristate - if true then a tristate (false, true, null) button model is used

Returns:

a toggle control

toggleControl

public static Controls.ToggleControl toggleControl(State state)

Creates a ToggleControl based on the given State

Parameters:

state - the state to toggle

Returns:

a ToggleControl based on the given state

toggleControl

public static Controls.ToggleControl toggleControl(State state,
                                                   java.lang.String name)

Creates a ToggleControl based on the given State

Parameters:

state - the state to toggle

name - the name of this control

Returns:

a ToggleControl based on the given state

toggleControl

public static Controls.ToggleControl toggleControl(State state,
                                                   java.lang.String name,
                                                   StateObserver enabledState)

Creates a ToggleControl based on the given State

Parameters:

state - the state to toggle

name - the name of this control

enabledState - the state which controls the enabled state of the control

Returns:

a ToggleControl based on the given state

toggleControl

public static Controls.ToggleControl toggleControl(State state,
                                                   java.lang.String name,
                                                   StateObserver enabledState,
                                                   javax.swing.Icon icon)

Creates a ToggleControl based on the given State

Parameters:

state - the state to toggle

name - the name of this control

enabledState - the state which controls the enabled state of the control

icon - the icon

Returns:

a ToggleControl based on the given state

toggleControl

public static Controls.ToggleControl toggleControl(Value<java.lang.Boolean> value)

Creates a ToggleControl based on the given boolean Value. If the value is nullable then a TristateButtonModel is used.

Parameters:

value - the value to toggle

Returns:

a ToggleControl based on the given state

See Also:

ValueObserver.isNullable()

toggleControl

public static Controls.ToggleControl toggleControl(Value<java.lang.Boolean> value,
                                                   java.lang.String name)

Creates a ToggleControl based on the given boolean Value If the value is nullable then a TristateButtonModel is used.

Parameters:

value - the value to toggle

name - the name of this control

Returns:

a ToggleControl based on the given state

See Also:

ValueObserver.isNullable()

toggleControl

public static Controls.ToggleControl toggleControl(Value<java.lang.Boolean> value,
                                                   java.lang.String name,
                                                   StateObserver enabledState)

Creates a ToggleControl based on the given boolean Value If the value is nullable then a TristateButtonModel is used.

Parameters:

value - the value to toggle

name - the name of this control

enabledState - the state which controls the enabled state of the control

Returns:

a ToggleControl based on the given state

See Also:

ValueObserver.isNullable()

toggleControl

public static Controls.ToggleControl toggleControl(Value<java.lang.Boolean> value,
                                                   java.lang.String name,
                                                   StateObserver enabledState,
                                                   javax.swing.Icon icon)

Creates a ToggleControl based on the given boolean Value If the value is nullable then a TristateButtonModel is used.

Parameters:

value - the value to toggle

name - the name of this control

enabledState - the state which controls the enabled state of the control

icon - the icon

Returns:

a ToggleControl based on the given state

See Also:

ValueObserver.isNullable()

eventControl

public static Control eventControl(Event<java.awt.event.ActionEvent> event)

Creates a Control which fires the given event on action performed

Parameters:

event - the event

Returns:

a control which fires the given event