Class StringConstraintEditor
- java.lang.Object
-
- docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor<java.lang.String>
-
- docking.widgets.table.constrainteditor.StringConstraintEditor
-
- All Implemented Interfaces:
ColumnConstraintEditor<java.lang.String>
public class StringConstraintEditor extends AbstractColumnConstraintEditor<java.lang.String>
A constraint editor for String-type values.
-
-
Field Summary
Fields Modifier and Type Field Description protected javax.swing.JTextField
textField
-
Fields inherited from class docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor
currentConstraint, INVALID_INPUT_COLOR, VALID_INPUT_COLOR
-
-
Constructor Summary
Constructors Constructor Description StringConstraintEditor(StringColumnConstraint constraint, java.lang.String errorMessage)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.awt.Component
buildInlineEditorComponent()
Delegate the construction of the inline editor component.protected boolean
checkEditorValueValidity()
Template method that subclasses must implement.java.lang.String
getErrorMessage()
If the editor contains and invalid value, this message should indicate why the value is invalid.protected ColumnConstraint<java.lang.String>
getValueFromComponent()
Get the constraints' new value from the editor component.void
reset()
Reset the editor to a known-good state.protected void
updateEditorComponent()
Indicates to subclasses that the constraint has changed, and the user interface needs to be updated to reflect the new state.protected void
updateInfoMessage(boolean isValid)
-
Methods inherited from class docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor
addChangeListener, buildDetailEditorComponent, formatStatus, getDetailComponent, getInlineComponent, getValue, hasEditorComponents, hasValidValue, notifyConstraintChanged, removeChangeListener, setValue, valueChanged
-
-
-
-
Constructor Detail
-
StringConstraintEditor
public StringConstraintEditor(StringColumnConstraint constraint, java.lang.String errorMessage)
Constructor.- Parameters:
constraint
- String-type constraint for which this component is an editor.errorMessage
- the message to display if the textField is blank.
-
-
Method Detail
-
buildInlineEditorComponent
protected java.awt.Component buildInlineEditorComponent()
Description copied from class:AbstractColumnConstraintEditor
Delegate the construction of the inline editor component.- Specified by:
buildInlineEditorComponent
in classAbstractColumnConstraintEditor<java.lang.String>
- Returns:
- the editors inline component
- See Also:
AbstractColumnConstraintEditor.getInlineComponent()
-
getValueFromComponent
protected ColumnConstraint<java.lang.String> getValueFromComponent()
Description copied from class:AbstractColumnConstraintEditor
Get the constraints' new value from the editor component. This expects the UI to have been constructed.- Specified by:
getValueFromComponent
in classAbstractColumnConstraintEditor<java.lang.String>
- Returns:
- See Also:
AbstractColumnConstraintEditor.getValue()
-
reset
public void reset()
Description copied from interface:ColumnConstraintEditor
Reset the editor to a known-good state.
-
checkEditorValueValidity
protected boolean checkEditorValueValidity()
Description copied from class:AbstractColumnConstraintEditor
Template method that subclasses must implement. This class will call this method whenever the value changes so that the validity state is updated.Only called when the editor component has been constructed and UI elements are defined.
- Specified by:
checkEditorValueValidity
in classAbstractColumnConstraintEditor<java.lang.String>
- Returns:
- true if the UI defines a valid value, false otherwise
- See Also:
ColumnConstraintEditor.hasValidValue()
-
updateInfoMessage
protected void updateInfoMessage(boolean isValid)
- Specified by:
updateInfoMessage
in classAbstractColumnConstraintEditor<java.lang.String>
-
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.- Returns:
- an error message, or an empty string if no error
-
updateEditorComponent
protected void updateEditorComponent()
Description copied from class:AbstractColumnConstraintEditor
Indicates to subclasses that the constraint has changed, and the user interface needs to be updated to reflect the new state.- Specified by:
updateEditorComponent
in classAbstractColumnConstraintEditor<java.lang.String>
-
-