com.palantir.ptoss.cinch.swing

Annotation Type Bound

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface Bound

Used to bind a UI control to a model property, where property is meant in a strict Java sense.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	to The property to bind to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	events A hint as to what event should be used to listen to the component for changes.
java.lang.String	nullValue Used to add a null value to a JComboBox.
java.lang.String[]	on Specifies the ModelUpdates on which the binding will occur.
java.lang.String	value Used for enum/boolean values for JRadioButtons and JToggleButtons.

Element Detail

to

public abstract java.lang.String to

The property to bind to.

on

public abstract java.lang.String[] on

Specifies the ModelUpdates on which the binding will occur. Defaults to empty, which indicates all updates.

Note: when bound to a specific ModelUpdate, a control will not receive not sent specifically to any ModelUpdate - i.e. default updates. To selectively answer a specific ModelUpdate and also still get default notications, add ModelUpdates.UNSPECIFIED to the list of ModelUpdates passed to on().

See Also:

ModelUpdates

Default:

""

value

public abstract java.lang.String value

Used for enum/boolean values for JRadioButtons and JToggleButtons. Valid values for booleans are "true", "false", and unset. When "true" the button will indicate a selected state, "false" indicates unselected state, and unset will indicate the state of the backing boolean.

Default:

""

nullValue

public abstract java.lang.String nullValue

Used to add a null value to a JComboBox.

Default:

""

events

public abstract java.lang.String[] events

A hint as to what event should be used to listen to the component for changes. Currently only used by the JTextComponentWiringHarness. Default is to use a document listener, which will fire the binding every time the document changes. Use event="actionPerformed" to use an ActionListener instead, or event="focusLost" to use focus loss.

Default:

{}