Class AutocompletingStringConstraintEditor
- java.lang.Object
-
- docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor<T>
-
- docking.widgets.table.constrainteditor.DataLoadingConstraintEditor<java.lang.String>
-
- docking.widgets.table.constrainteditor.AutocompletingStringConstraintEditor
-
- All Implemented Interfaces:
ColumnConstraintEditor<java.lang.String>
,TaskListener
public class AutocompletingStringConstraintEditor extends DataLoadingConstraintEditor<java.lang.String>
An editor that provides suggestions of values that, according to StringColumnConstraint, match a user-supplied pattern.
-
-
Field Summary
Fields Modifier and Type Field Description protected DropDownTextField<java.lang.String>
textField
-
Fields inherited from class docking.widgets.table.constrainteditor.DataLoadingConstraintEditor
columnDataSource, statusLabel
-
Fields inherited from class docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor
currentConstraint, INVALID_INPUT_COLOR, VALID_INPUT_COLOR
-
-
Constructor Summary
Constructors Constructor Description AutocompletingStringConstraintEditor(StringColumnConstraint constraint, ColumnData<java.lang.String> columnDataSource)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.awt.Component
buildDelegateInlineEditor()
Get the delegates' inline editor componentprotected boolean
checkEditorValueValidity()
Template method that subclasses must implement.void
clearColumnData()
Request that any state maintained by the delegate editor pertaining to column data be cleared.void
columnDataLoadCancelled()
Notification that the column data-load was cancelled.void
columnDataLoadComplete()
Notification that the column data-load has been completed.protected void
doUpdateEditorComponent()
Indicates the constraint has changed, and the user interface needs to be updated to reflect the new state.protected ColumnConstraint<java.lang.String>
getValueFromComponent()
Get the constraints' new value from the editor component.void
handleColumnDataValue(java.lang.String value)
A value has been read from the table (column); handle it in an editor-specific way.protected void
resetEditor()
Reset the delegate editor to a known stateprotected void
updateInfoMessage(boolean isValid)
-
Methods inherited from class docking.widgets.table.constrainteditor.DataLoadingConstraintEditor
buildDelegateDetailEditor, buildDetailEditorComponent, buildInlineEditorComponent, getErrorMessage, reset, taskCancelled, taskCompleted, updateEditorComponent
-
Methods inherited from class docking.widgets.table.constrainteditor.AbstractColumnConstraintEditor
addChangeListener, formatStatus, getDetailComponent, getInlineComponent, getValue, hasEditorComponents, hasValidValue, notifyConstraintChanged, removeChangeListener, setValue, valueChanged
-
-
-
-
Field Detail
-
textField
protected DropDownTextField<java.lang.String> textField
-
-
Constructor Detail
-
AutocompletingStringConstraintEditor
public AutocompletingStringConstraintEditor(StringColumnConstraint constraint, ColumnData<java.lang.String> columnDataSource)
Constructor.- Parameters:
constraint
- String constraint for which this component is an editorcolumnDataSource
- provides access to table data and. Must be non-null.
-
-
Method Detail
-
buildDelegateInlineEditor
protected java.awt.Component buildDelegateInlineEditor()
Description copied from class:DataLoadingConstraintEditor
Get the delegates' inline editor component- Overrides:
buildDelegateInlineEditor
in classDataLoadingConstraintEditor<java.lang.String>
- Returns:
- the inline editor for the delegate constraint
-
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>
-
resetEditor
protected void resetEditor()
Description copied from class:DataLoadingConstraintEditor
Reset the delegate editor to a known state- Specified by:
resetEditor
in classDataLoadingConstraintEditor<java.lang.String>
- See Also:
DataLoadingConstraintEditor.reset()
-
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 classDataLoadingConstraintEditor<java.lang.String>
- Returns:
- See Also:
AbstractColumnConstraintEditor.getValue()
-
handleColumnDataValue
public void handleColumnDataValue(java.lang.String value)
Description copied from class:DataLoadingConstraintEditor
A value has been read from the table (column); handle it in an editor-specific way.- Specified by:
handleColumnDataValue
in classDataLoadingConstraintEditor<java.lang.String>
- Parameters:
value
- the value read from the table (column)
-
columnDataLoadComplete
public void columnDataLoadComplete()
Description copied from class:DataLoadingConstraintEditor
Notification that the column data-load has been completed.- Overrides:
columnDataLoadComplete
in classDataLoadingConstraintEditor<java.lang.String>
-
columnDataLoadCancelled
public void columnDataLoadCancelled()
Description copied from class:DataLoadingConstraintEditor
Notification that the column data-load was cancelled.- Overrides:
columnDataLoadCancelled
in classDataLoadingConstraintEditor<java.lang.String>
-
clearColumnData
public void clearColumnData()
Description copied from class:DataLoadingConstraintEditor
Request that any state maintained by the delegate editor pertaining to column data be cleared.- Overrides:
clearColumnData
in classDataLoadingConstraintEditor<java.lang.String>
-
doUpdateEditorComponent
protected void doUpdateEditorComponent()
Description copied from class:DataLoadingConstraintEditor
Indicates the constraint has changed, and the user interface needs to be updated to reflect the new state.- Specified by:
doUpdateEditorComponent
in classDataLoadingConstraintEditor<java.lang.String>
-
-