com.guiseframework.component
Class TextControl<V>

java.lang.Object
  com.globalmentor.beans.BoundPropertyObject
      com.guiseframework.event.GuiseBoundPropertyObject
          com.guiseframework.model.ui.AbstractPresentationModel
              com.guiseframework.component.AbstractComponent
                  com.guiseframework.component.AbstractControl
                      com.guiseframework.component.AbstractValueControl<V>
                          com.guiseframework.component.AbstractEditValueControl<V>
                              com.guiseframework.component.AbstractTextControl<V>
                                  com.guiseframework.component.TextControl<V>

Type Parameters:

V - The type of value the input text is to represent.

All Implemented Interfaces:

com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Component, Control, EditComponent, InputFocusableComponent, ValueControl<V>, ValuedComponent<V>, EditListenable, Displayable, Enableable, InfoModel, LabelModel, Model, PresentationModel, Valued<V>, ValueModel<V>, DepictedObject

public class TextControl<V>
extends AbstractTextControl<V>

Control to accept text input from the user representing a particular value type. This control keeps track of literal text entered by the user, distinct from the value stored in the model. If line wrap is not specified in the constructor, it defaults to true. If multiline is not specified in the constructor, it defaults to true only when there is more than one row and line wrap is turned off. Default converters are available for the following types:

• char[]
• java.lang.Boolean
• java.lang.Float
• java.lang.Integer
• java.lang.String

This component installs a default export strategy supporting export of the following content types:

• text/plain

This component installs a default import strategy supporting import of the following content types:

• text/*

This control uses a single line feed character to represent each line break.

Author:

Garret Wilson

Nested Class Summary

protected static class

TextControl.DefaultTransferable The default transferable object for a text control.

Nested classes/interfaces inherited from class com.guiseframework.component.AbstractComponent

AbstractComponent.AbstractFlyoverFrameStrategy<S extends Component>, AbstractComponent.AbstractFlyoverStrategy<S extends Component>, AbstractComponent.DefaultFlyoverStrategy<S extends Component>

Nested classes/interfaces inherited from interface com.guiseframework.component.Component

Component.FlyoverStrategy<S extends Component>

Nested classes/interfaces inherited from interface com.guiseframework.component.Control

Control.Status

Field Summary

protected static ExportStrategy<TextControl<?>>	DEFAULT_EXPORT_STRATEGY The default export strategy for this component type.
protected static ImportStrategy<TextControl<?>>	DEFAULT_IMPORT_STRATEGY The default import strategy for this component type.
static java.lang.String	LINE_WRAP_PROPERTY The line wrap bound property.
static java.lang.String	MASKED_PROPERTY The masked bound property.
static java.lang.String	MAXIMUM_LENGTH_PROPERTY The maximum length bound property.
static java.lang.String	MULTILINE_PROPERTY The multiline bound property.
static java.lang.String	ROW_COUNT_PROPERTY The row count bound property.

Fields inherited from class com.guiseframework.component.AbstractTextControl

AUTO_COMMIT_PATTERN_PROPERTY, COLUMN_COUNT_PROPERTY, PROVISIONAL_TEXT_PROPERTY, TEXT_PROPERTY, VALUE_CONTENT_TYPE_PROPERTY

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface com.guiseframework.component.EditComponent

EDITABLE_PROPERTY

Fields inherited from interface com.guiseframework.component.Component

BOOKMARK_ENABLED_PROPERTY, CONSTRAINTS_PROPERTY, DRAG_ENABLED_PROPERTY, DROP_ENABLED_PROPERTY, FLYOVER_ENABLED_PROPERTY, FLYOVER_STRATEGY_PROPERTY, INPUT_STRATEGY_PROPERTY, NAME_PROPERTY, NOTIFICATION_PROPERTY, ORIENTATION_PROPERTY, THEME_APPLIED_PROPERTY, VALID_PROPERTY

Fields inherited from interface com.guiseframework.model.ui.PresentationModel

BACKGROUND_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CURSOR_PROPERTY, FONT_FAMILIES_PROPERTY, FONT_SIZE_PROPERTY, FONT_STYLE_PROPERTY, FONT_WEIGHT_BOLD, FONT_WEIGHT_NORMAL, FONT_WEIGHT_PROPERTY, LABEL_FONT_FAMILIES_PROPERTY, LABEL_FONT_SIZE_PROPERTY, LABEL_FONT_STYLE_PROPERTY, LABEL_FONT_WEIGHT_PROPERTY, LABEL_TEXT_COLOR_PROPERTY, LINE_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, OPACITY_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PAGE_EXTENT_PROPERTY, ROUNDED_CORNER_ARC_SIZE, STYLE_ID_PROPERTY, TEXT_COLOR_PROPERTY, TOOLTIP_ENABLED_PROPERTY, VISIBLE_PROPERTY

Fields inherited from interface com.guiseframework.model.Displayable

DISPLAYED_PROPERTY

Fields inherited from interface com.guiseframework.model.InfoModel

DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY

Fields inherited from interface com.guiseframework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Fields inherited from interface com.guiseframework.model.Model

PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE

Fields inherited from interface com.guiseframework.component.ValueControl

CONVERTER_PROPERTY

Fields inherited from interface com.guiseframework.component.Control

STATUS_PROPERTY

Fields inherited from interface com.guiseframework.model.Enableable

ENABLED_PROPERTY

Fields inherited from interface com.guiseframework.model.ValueModel

VALIDATOR_PROPERTY, VALUE_PROPERTY

Constructor Summary

TextControl(java.lang.Class<V> valueClass)
Value class constructor with a default data model to represent a given type and a default converter.

TextControl(java.lang.Class<V> valueClass, int columnCount)
Value class and column count constructor with one row and a default converter.

TextControl(java.lang.Class<V> valueClass, int rowCount, int columnCount)
Value class, row count, and column count constructor with a default converter.

TextControl(java.lang.Class<V> valueClass, int rowCount, int columnCount, boolean lineWrap)
Value class, row count, column count, and line wrap constructor with a default converter.

TextControl(java.lang.Class<V> valueClass, V defaultValue)
Value class and default value constructor with a default data model to represent a given type and a default converter.

TextControl(java.lang.Class<V> valueClass, V defaultValue, int columnCount)
Value class, defaultValue, and column count constructor with one row a default converter.

TextControl(java.lang.Class<V> valueClass, V defaultValue, int rowCount, int columnCount)
Value class, defaultValue, row count, and column count constructor with a default converter.

TextControl(java.lang.Class<V> valueClass, V defaultValue, int rowCount, int columnCount, boolean lineWrap)
Value class, default value, row count, column count, and line wrap constructor with a default converter.

TextControl(ValueModel<V> valueModel)
Value model constructor with a default converter.

TextControl(ValueModel<V> valueModel, Converter<V,java.lang.String> converter)
Value model and converter constructor.

TextControl(ValueModel<V> valueModel, Converter<V,java.lang.String> converter, int rowCount, int columnCount, boolean lineWrap)
Value model, converter, row count, column count, and line wrap constructor.

TextControl(ValueModel<V> valueModel, Converter<V,java.lang.String> converter, int rowCount, int columnCount, boolean lineWrap, boolean multiline)
Value model, converter, row count, column count, and line wrap constructor.

TextControl(ValueModel<V> valueModel, int rowCount, int columnCount)
Value model, row count, and column count constructor with a default converter.

TextControl(ValueModel<V> valueModel, int rowCount, int columnCount, boolean lineWrap)
Value model, row count, column count, and line wrap constructor with a default converter.

Method Summary

int	getMaximumLength()
int	getRowCount()
boolean	isLineWrap()
boolean	isMasked()
boolean	isMultiline()
void	setLineWrap(boolean newLineWrap) Sets whether lines will be logically wrapped in the view if needed.
void	setMasked(boolean newMasked) Sets whether the user input text is masked to prevent viewing of the literal entered value.
void	setMaximumLength(int newMaximumLength) Sets the maximum number of input characters to allow.
void	setMultiline(boolean newMultiline) Sets whether the user is allowed to enter multiple physical lines if the control has multiple rows.
void	setRowCount(int newRowCount) Sets the estimated number of rows requested to be visible.

Methods inherited from class com.guiseframework.component.AbstractTextControl

determineStatus, determineValid, getAutoCommitPattern, getColumnCount, getConverter, getProvisionalText, getText, getValueContentType, reset, setAutoCommitPattern, setColumnCount, setConverter, setProvisionalText, setText, setTextValue, setValueContentType, updateText, validate

Methods inherited from class com.guiseframework.component.AbstractEditValueControl

addEditListener, fireEdited, fireEdited, isEditable, removeEditListener, setEditable

Methods inherited from class com.guiseframework.component.AbstractValueControl

clearValue, getDefaultValue, getValidator, getValue, getValueClass, getValueModel, isValidValue, resetValue, setValidator, setValue, validateValue

Methods inherited from class com.guiseframework.component.AbstractControl

getEnableable, getStatus, isEnabled, setEnabled, setNotification, setStatus, updateStatus, updateValid

Methods inherited from class com.guiseframework.component.AbstractComponent

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, depict, dispatchInputEvent, equals, exportTransfer, fireInputEvent, fireNotified, fireNotified, getAncestor, getCommandListeners, getComponentByID, getComponentByName, getComponentOrientation, getConstraints, getDepictID, getDepictor, getDescription, getDescriptionContentType, getDirtyComponents, getDirtyComponents, getEventListenerManager, getFlyoverStrategy, getGlyphURI, getInfo, getInfoContentType, getInfoModel, getInputStrategy, getKeyListeners, getLabel, getLabelContentType, getMouseListeners, getName, getNotification, getNotifications, getNotifications, getOrientation, getParent, getPreferenceProperties, getRootComponent, getTheme, hasAncestor, hasCommandListeners, hashCode, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, loadPreferences, notify, processEvent, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, resetTheme, savePreferences, setConstraints, setDepicted, setDescription, setDescriptionContentType, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setGlyphURI, setInfo, setInfoContentType, setInputStrategy, setLabel, setLabelContentType, setName, setOrientation, setParent, setThemeApplied, setValid, toString, update, updateTheme

Methods inherited from class com.guiseframework.model.ui.AbstractPresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from class com.guiseframework.event.GuiseBoundPropertyObject

getSession

Methods inherited from class com.globalmentor.beans.BoundPropertyObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.guiseframework.component.Component

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, dispatchInputEvent, exportTransfer, fireInputEvent, getAncestor, getComponentOrientation, getConstraints, getDepictor, getFlyoverStrategy, getInputStrategy, getName, getNotification, getOrientation, getParent, getPreferenceProperties, getTheme, hasCommandListeners, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, loadPreferences, notify, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, resetTheme, savePreferences, setConstraints, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setInputStrategy, setName, setNotification, setOrientation, setParent, setThemeApplied, updateTheme

Methods inherited from interface com.guiseframework.platform.DepictedObject

depict, getDepictID, getSession, processEvent

Methods inherited from interface com.guiseframework.model.ui.PresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getSession, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from interface com.guiseframework.model.InfoModel

getDescription, getDescriptionContentType, getInfo, getInfoContentType, setDescription, setDescriptionContentType, setInfo, setInfoContentType

Methods inherited from interface com.guiseframework.model.LabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.guiseframework.component.Control

getStatus

Methods inherited from interface com.guiseframework.model.Enableable

isEnabled, setEnabled

Field Detail

LINE_WRAP_PROPERTY

public static final java.lang.String LINE_WRAP_PROPERTY

The line wrap bound property.

MASKED_PROPERTY

public static final java.lang.String MASKED_PROPERTY

The masked bound property.

MAXIMUM_LENGTH_PROPERTY

public static final java.lang.String MAXIMUM_LENGTH_PROPERTY

The maximum length bound property.

MULTILINE_PROPERTY

public static final java.lang.String MULTILINE_PROPERTY

The multiline bound property.

ROW_COUNT_PROPERTY

public static final java.lang.String ROW_COUNT_PROPERTY

The row count bound property.

DEFAULT_EXPORT_STRATEGY

protected static final ExportStrategy<TextControl<?>> DEFAULT_EXPORT_STRATEGY

The default export strategy for this component type.

DEFAULT_IMPORT_STRATEGY

protected static final ImportStrategy<TextControl<?>> DEFAULT_IMPORT_STRATEGY

The default import strategy for this component type.

Constructor Detail

TextControl

public TextControl(java.lang.Class<V> valueClass)

Value class constructor with a default data model to represent a given type and a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(java.lang.Class<V> valueClass,
                   V defaultValue)

Value class and default value constructor with a default data model to represent a given type and a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

defaultValue - The default value, which will not be validated.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(java.lang.Class<V> valueClass,
                   int columnCount)

Value class and column count constructor with one row and a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(java.lang.Class<V> valueClass,
                   int rowCount,
                   int columnCount)

Value class, row count, and column count constructor with a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(java.lang.Class<V> valueClass,
                   V defaultValue,
                   int columnCount)

Value class, defaultValue, and column count constructor with one row a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

defaultValue - The default value, which will not be validated.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(java.lang.Class<V> valueClass,
                   V defaultValue,
                   int rowCount,
                   int columnCount)

Value class, defaultValue, row count, and column count constructor with a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

defaultValue - The default value, which will not be validated.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(java.lang.Class<V> valueClass,
                   int rowCount,
                   int columnCount,
                   boolean lineWrap)

Value class, row count, column count, and line wrap constructor with a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

lineWrap - Whether lines should be wrapped in the view if needed.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(java.lang.Class<V> valueClass,
                   V defaultValue,
                   int rowCount,
                   int columnCount,
                   boolean lineWrap)

Value class, default value, row count, column count, and line wrap constructor with a default converter.

Parameters:

valueClass - The class indicating the type of value held in the model.

defaultValue - The default value, which will not be validated.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

lineWrap - Whether lines should be wrapped in the view if needed.

Throws:

java.lang.NullPointerException - if the given value class is null.

TextControl

public TextControl(ValueModel<V> valueModel,
                   int rowCount,
                   int columnCount)

Value model, row count, and column count constructor with a default converter.

Parameters:

valueModel - The component value model.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

Throws:

java.lang.NullPointerException - if the given value model is null.

TextControl

public TextControl(ValueModel<V> valueModel,
                   int rowCount,
                   int columnCount,
                   boolean lineWrap)

Value model, row count, column count, and line wrap constructor with a default converter.

Parameters:

valueModel - The component value model.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

lineWrap - Whether lines should be wrapped in the view if needed.

Throws:

java.lang.NullPointerException - if the given value model is null.

TextControl

public TextControl(ValueModel<V> valueModel)

Value model constructor with a default converter.

Parameters:

valueModel - The component value model.

Throws:

java.lang.NullPointerException - if the given value model is null.

TextControl

public TextControl(ValueModel<V> valueModel,
                   Converter<V,java.lang.String> converter)

Value model and converter constructor.

Parameters:

valueModel - The component value model.

converter - The converter for this component.

Throws:

java.lang.NullPointerException - if the given value model and/or converter is null.

TextControl

public TextControl(ValueModel<V> valueModel,
                   Converter<V,java.lang.String> converter,
                   int rowCount,
                   int columnCount,
                   boolean lineWrap)

Value model, converter, row count, column count, and line wrap constructor.

Parameters:

valueModel - The component value model.

converter - The converter for this component.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

lineWrap - Whether lines should be wrapped in the view if needed.

Throws:

java.lang.NullPointerException - if the given value model and/or converter is null.

TextControl

public TextControl(ValueModel<V> valueModel,
                   Converter<V,java.lang.String> converter,
                   int rowCount,
                   int columnCount,
                   boolean lineWrap,
                   boolean multiline)

Value model, converter, row count, column count, and line wrap constructor.

Parameters:

valueModel - The component value model.

converter - The converter for this component.

rowCount - The requested number of visible rows, or -1 if no row count is specified.

columnCount - The requested number of visible columns, or -1 if no column count is specified.

lineWrap - Whether lines should be wrapped in the view if needed.

multiline - Whether the user should be allowed to enter multiple physical lines if the control has multiple rows.

Throws:

java.lang.NullPointerException - if the given value model and/or converter is null.

Method Detail

isMasked

public boolean isMasked()

Returns:

Whether the user input text is masked to prevent viewing of the literal entered value.

setMasked

public void setMasked(boolean newMasked)

Sets whether the user input text is masked to prevent viewing of the literal entered value. This is a bound property of type Boolean.

Parameters:

newMasked - true if the user input text should be masked.

See Also:

MASKED_PROPERTY

getMaximumLength

public int getMaximumLength()

Returns:

The maximum number of input characters to allow, or -1 if there is no maximum length.

setMaximumLength

public void setMaximumLength(int newMaximumLength)

Sets the maximum number of input characters to allow. This is a bound property of type Integer.

Parameters:

newMaximumLength - The new maximum number of input characters to allow, or -1 if there is no maximum length.

See Also:

MAXIMUM_LENGTH_PROPERTY

isLineWrap

public boolean isLineWrap()

Returns:

Whether lines will be logically wrapped in the view if needed.

setLineWrap

public void setLineWrap(boolean newLineWrap)

Sets whether lines will be logically wrapped in the view if needed. This is a bound property of type Boolean.

Parameters:

newLineWrap - Whether lines should be logically wrapped in the view if needed.

See Also:

LINE_WRAP_PROPERTY

isMultiline

public boolean isMultiline()

Returns:

Whether the user is allowed to enter multiple physical lines if the control has multiple rows.

setMultiline

public void setMultiline(boolean newMultiline)

Sets whether the user is allowed to enter multiple physical lines if the control has multiple rows. This is a bound property of type Boolean.

Parameters:

newMultiline - Whether the user should be allowed to enter multiple physical lines if the control has multiple rows.

See Also:

MULTILINE_PROPERTY

getRowCount

public int getRowCount()

Returns:

The estimated number of rows requested to be visible, or -1 if no row count is specified.

setRowCount

public void setRowCount(int newRowCount)

Sets the estimated number of rows requested to be visible. This is a bound property of type Integer.

Parameters:

newRowCount - The new requested number of visible rows, or -1 if no row count is specified.

See Also:

ROW_COUNT_PROPERTY