Class DummyConstraintEditor<T>
- java.lang.Object
-
- docking.widgets.table.constrainteditor.DummyConstraintEditor<T>
-
- Type Parameters:
T
-
- All Implemented Interfaces:
ColumnConstraintEditor<T>
public final class DummyConstraintEditor<T> extends java.lang.Object implements ColumnConstraintEditor<T>
An editor that is always invalid.Used internally to indicate a constraint does not provide an editor of its own.
-
-
Constructor Summary
Constructors Constructor Description DummyConstraintEditor(java.lang.String message)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChangeListener(javax.swing.event.ChangeListener constraintEditorChangeListener)
Register a callback handler for responding to changes made within the editorjava.awt.Component
getDetailComponent()
The detail component resides in the configuration interface below the column and constraint selection widgets, and is afforded greater space.java.lang.String
getErrorMessage()
If the editor contains and invalid value, this message should indicate why the value is invalid.java.awt.Component
getInlineComponent()
The inline component resides in the configuration interface on the same visual line as the column and constraint selection widgets.ColumnConstraint<T>
getValue()
Get the current value from the editor, in the form of a constraint.boolean
hasValidValue()
Determine if the editor contains a valid value; do the UI widgets and state match, is the state sensible for the constraint.void
removeChangeListener(javax.swing.event.ChangeListener constraintEditorChangeListener)
Remove a callback handler that was responding changes made within the editorvoid
reset()
Reset the editor to a known-good state.void
setValue(ColumnConstraint<T> value)
Set the current value within the editor
-
-
-
Method Detail
-
getInlineComponent
public java.awt.Component getInlineComponent()
Description copied from interface:ColumnConstraintEditor
The inline component resides in the configuration interface on the same visual line as the column and constraint selection widgets. It is intended to be a relatively small and simple interface for configuring the constraints' values.- Specified by:
getInlineComponent
in interfaceColumnConstraintEditor<T>
- Returns:
- the inline editor component
-
getDetailComponent
public java.awt.Component getDetailComponent()
Description copied from interface:ColumnConstraintEditor
The detail component resides in the configuration interface below the column and constraint selection widgets, and is afforded greater space. It is intended to be a more feature-rich editor that provides greater insight or control of the constraints value definition.- Specified by:
getDetailComponent
in interfaceColumnConstraintEditor<T>
- Returns:
- the detail editor component
-
getValue
public ColumnConstraint<T> getValue()
Description copied from interface:ColumnConstraintEditor
Get the current value from the editor, in the form of a constraint.- Specified by:
getValue
in interfaceColumnConstraintEditor<T>
- Returns:
- the editors' current value
-
setValue
public void setValue(ColumnConstraint<T> value)
Description copied from interface:ColumnConstraintEditor
Set the current value within the editor- Specified by:
setValue
in interfaceColumnConstraintEditor<T>
- Parameters:
value
- the new value to set
-
reset
public void reset()
Description copied from interface:ColumnConstraintEditor
Reset the editor to a known-good state.- Specified by:
reset
in interfaceColumnConstraintEditor<T>
-
hasValidValue
public boolean hasValidValue()
Description copied from interface:ColumnConstraintEditor
Determine if the editor contains a valid value; do the UI widgets and state match, is the state sensible for the constraint.- Specified by:
hasValidValue
in interfaceColumnConstraintEditor<T>
- Returns:
- true if the configuration is valid, false otherwise
-
getErrorMessage
public java.lang.String getErrorMessage()
Description copied from interface:ColumnConstraintEditor
If the editor contains and invalid value, this message should indicate why the value is invalid. Only called ifhasValidValue()
returns false.- Specified by:
getErrorMessage
in interfaceColumnConstraintEditor<T>
- Returns:
- an error message, or an empty string if no error
-
addChangeListener
public void addChangeListener(javax.swing.event.ChangeListener constraintEditorChangeListener)
Description copied from interface:ColumnConstraintEditor
Register a callback handler for responding to changes made within the editor- Specified by:
addChangeListener
in interfaceColumnConstraintEditor<T>
- Parameters:
constraintEditorChangeListener
- listener callback
-
removeChangeListener
public void removeChangeListener(javax.swing.event.ChangeListener constraintEditorChangeListener)
Description copied from interface:ColumnConstraintEditor
Remove a callback handler that was responding changes made within the editor- Specified by:
removeChangeListener
in interfaceColumnConstraintEditor<T>
- Parameters:
constraintEditorChangeListener
- listener callback
-
-