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 Change Modifier and Type Field Description NEW protected javax.swing.JTextFieldtextField-
Fields inherited from class docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor
currentConstraint, INVALID_INPUT_COLOR, VALID_INPUT_COLOR
-
-
Constructor Summary
Constructors Change Constructor Description StringConstraintEditor(StringColumnConstraint constraint, java.lang.String errorMessage)Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Change Modifier and Type Method Description NEW protected java.awt.ComponentbuildInlineEditorComponent()Delegate the construction of the inline editor component.NEW protected booleancheckEditorValueValidity()Template method that subclasses must implement.java.lang.StringgetErrorMessage()If the editor contains and invalid value, this message should indicate why the value is invalid.NEW protected ColumnConstraint<java.lang.String>getValueFromComponent()Get the constraints' new value from the editor component.voidreset()Reset the editor to a known-good state.NEW protected voidupdateEditorComponent()Indicates to subclasses that the constraint has changed, and the user interface needs to be updated to reflect the new state.NEW protected voidupdateInfoMessage(boolean isValid)-
Methods inherited from class docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor
addChangeListener, buildDetailEditorComponent, formatStatus, getDetailComponent, getInlineComponent, getValue, hasEditorComponents, hasValidValue, notifyConstraintChanged, removeChangeListener, setValue, valueChanged
-
-
-
-
Field Detail
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 NEW
protected java.awt.Component buildInlineEditorComponent()
Description copied from class:AbstractColumnConstraintEditorDelegate the construction of the inline editor component.- Specified by:
buildInlineEditorComponentin classAbstractColumnConstraintEditor<java.lang.String>- Returns:
- the editors inline component
- See Also:
AbstractColumnConstraintEditor.getInlineComponent()
-
getValueFromComponent NEW
protected ColumnConstraint<java.lang.String> getValueFromComponent()
Description copied from class:AbstractColumnConstraintEditorGet the constraints' new value from the editor component. This expects the UI to have been constructed.- Specified by:
getValueFromComponentin classAbstractColumnConstraintEditor<java.lang.String>- Returns:
- See Also:
AbstractColumnConstraintEditor.getValue()
-
reset
public void reset()
Description copied from interface:ColumnConstraintEditorReset the editor to a known-good state.
-
checkEditorValueValidity NEW
protected boolean checkEditorValueValidity()
Description copied from class:AbstractColumnConstraintEditorTemplate 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:
checkEditorValueValidityin classAbstractColumnConstraintEditor<java.lang.String>- Returns:
- true if the UI defines a valid value, false otherwise
- See Also:
ColumnConstraintEditor.hasValidValue()
-
updateInfoMessage NEW
protected void updateInfoMessage(boolean isValid)
- Specified by:
updateInfoMessagein classAbstractColumnConstraintEditor<java.lang.String>
-
getErrorMessage
public java.lang.String getErrorMessage()
Description copied from interface:ColumnConstraintEditorIf the editor contains and invalid value, this message should indicate why the value is invalid. Only called if hasValidValue() returns false.- Returns:
- an error message, or an empty string if no error
-
updateEditorComponent NEW
protected void updateEditorComponent()
Description copied from class:AbstractColumnConstraintEditorIndicates to subclasses that the constraint has changed, and the user interface needs to be updated to reflect the new state.- Specified by:
updateEditorComponentin classAbstractColumnConstraintEditor<java.lang.String>
-
-