net.sf.jzeno.echo.editor
Class StringEditor

java.lang.Object
  nextapp.echo.AbstractComponent
      net.sf.jzeno.echo.components.CustomComponent
          net.sf.jzeno.echo.editor.StringEditor

All Implemented Interfaces:

java.io.Serializable, BindingTarget, PropertyComponent, RebindableComponent, EventSink, EventSource, Precreation, Component, FastComponent, FastComponentContainer

public final class StringEditor
extends CustomComponent
implements Precreation

Default editor for Strings in the domain editor.

See Also:

Serialized Form

Field Summary

static int	CHARACTER_UNITS
static int	PERCENT_UNITS
static int	PIXEL_UNITS

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

StringEditor()

StringEditor(java.lang.Class beanClass, java.lang.String prop, java.lang.String constructionHints)

Method Summary

void	applyContext()
Color	getBackground() Gets the background color.
int	getColumns()
int	getExactLength() Gets the exact length the user input should be.
Color	getForeground() Gets the foreground (text) color.
java.lang.String	getInvalidMessage() Gets the message key that is added to the screen, when the component is marked as invalid.
java.lang.String	getInvalidMessageKey() Deprecated.
int	getMaximumLength() Gets the maximum number of characters the user may enter.
java.lang.String	getNullValue() Gets the input value that corresponds to a data binding property value null.
java.lang.String	getText() Sets the current value inside the input box.
java.lang.String	getToolTipText() Gets the tooltip that is shown when the user hoovers over this component.
int	getWidth() Gets the width of the text field.
int	getWidthUnits() Gets the units in which width is specified.
boolean	isAutoTrim() Gets whether or not this component trims the input from the user.
boolean	isConvertToLowerCase()
boolean	isConvertToUpperCase()
boolean	isReadOnly()
boolean	isRequired() Query if the editor is required to be filled in.
void	setAutoTrim(boolean autoTrim) Sets whether or not this component trims the input from the user.
void	setBackground(Color background) Sets the background color.
void	setColumns(int columns) Deprecated.
void	setConvertToLowerCase(boolean convertToLowerCase)
void	setConvertToUpperCase(boolean convertToUpperCase)
void	setExactLength(int exactLength) Sets the exact length the user input should be.
void	setFocused(boolean newValue) Sets the input focus to this component.
void	setForeground(Color foreground) Sets the foreground (text) color.
void	setInvalidMessage(java.lang.String invalidMessage) Sets the message key that is shown when the component is marked as invalid.
void	setInvalidMessageKey(java.lang.String invalidMessageKey) Deprecated.
void	setMaximumLength(int maxLength) Sets the maximum number of characters the user may enter.
void	setNullValue(java.lang.String nullValue) Sets the input value that corresponds to a data binding property value null
void	setReadOnly(boolean readOnly) Mark this component as read-only.
void	setRequired(boolean required) Determine if the editor is required to be filled in.
void	setText(java.lang.String text) Sets the text in the component.
void	setToolTipText(java.lang.String toolTipText) Sets the tooltip that is shown when the user hoovers over this component.
void	setWidth(int width) Sets the width of the text field.
void	setWidthUnits(int units) Sets the units in which width is specified.

Methods inherited from class net.sf.jzeno.echo.components.CustomComponent

addValidator, fireActionEvent, fireActionEvent, fireActionEvent, getActionCommand, getBean, getBeanClass, getDecorator, getNullObject, getProperty, getValidationErrors, getValidators, getValue, isBound, isMarkedInvalid, isValid, markInvalid, markValid, preRender, rebind, removeValidator, setActionCommand, setBean, setBeanClass, setDecorator, setNullObject, setProperty, setValue, traceValue, validate

Methods inherited from class nextapp.echo.AbstractComponent

add, add, addHierarchyListener, addPropertyChangeListener, applyStyle, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setClientId, setEnabled, setFont, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PIXEL_UNITS

public static final int PIXEL_UNITS

See Also:

Constant Field Values

CHARACTER_UNITS

public static final int CHARACTER_UNITS

See Also:

Constant Field Values

PERCENT_UNITS

public static final int PERCENT_UNITS

See Also:

Constant Field Values

Constructor Detail

StringEditor

public StringEditor()

StringEditor

public StringEditor(java.lang.Class beanClass,
                    java.lang.String prop,
                    java.lang.String constructionHints)

Method Detail

getNullValue

public java.lang.String getNullValue()

Gets the input value that corresponds to a data binding property value null.

setNullValue

public void setNullValue(java.lang.String nullValue)

Sets the input value that corresponds to a data binding property value null

getToolTipText

public java.lang.String getToolTipText()

Gets the tooltip that is shown when the user hoovers over this component.

setToolTipText

public void setToolTipText(java.lang.String toolTipText)

Sets the tooltip that is shown when the user hoovers over this component.

getInvalidMessageKey

public java.lang.String getInvalidMessageKey()

Deprecated.

setInvalidMessageKey

public void setInvalidMessageKey(java.lang.String invalidMessageKey)

Deprecated.

getInvalidMessage

public java.lang.String getInvalidMessage()

Gets the message key that is added to the screen, when the component is marked as invalid. Also see setInvalidMessageKey(String).

setInvalidMessage

public void setInvalidMessage(java.lang.String invalidMessage)

Sets the message key that is shown when the component is marked as invalid. Typically the component is marked invalid when you call EchoSupport.doValidationRecursively(Component) in your code. The value specified for this property is translated through the i18n support in jZeno (i18n.properties).

getExactLength

public int getExactLength()

Gets the exact length the user input should be.

setExactLength

public void setExactLength(int exactLength)

Sets the exact length the user input should be.

isAutoTrim

public boolean isAutoTrim()

Gets whether or not this component trims the input from the user. This means that any leading and/or trailing spaces are removed from the input.

setAutoTrim

public void setAutoTrim(boolean autoTrim)

Sets whether or not this component trims the input from the user. This means that any leading and/or trailing spaces are removed from the input.

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface PropertyComponent

Overrides:

isReadOnly in class CustomComponent

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: PropertyComponent

Mark this component as read-only.

Specified by:

setReadOnly in interface PropertyComponent

Overrides:

setReadOnly in class CustomComponent

isRequired

public boolean isRequired()

Description copied from interface: PropertyComponent

Query if the editor is required to be filled in.

Specified by:

isRequired in interface PropertyComponent

Overrides:

isRequired in class CustomComponent

setRequired

public void setRequired(boolean required)

Description copied from interface: PropertyComponent

Determine if the editor is required to be filled in.

Specified by:

setRequired in interface PropertyComponent

Overrides:

setRequired in class CustomComponent

setColumns

public void setColumns(int columns)

Deprecated.

Sets the width of the input field. Specified in characters on screen.

getColumns

public int getColumns()

setWidth

public void setWidth(int width)

Sets the width of the text field.

getWidth

public int getWidth()

Gets the width of the text field.

setWidthUnits

public void setWidthUnits(int units)

Sets the units in which width is specified.

getWidthUnits

public int getWidthUnits()

Gets the units in which width is specified.

setMaximumLength

public void setMaximumLength(int maxLength)

Sets the maximum number of characters the user may enter.

getMaximumLength

public int getMaximumLength()

Gets the maximum number of characters the user may enter.

getBackground

public Color getBackground()

Gets the background color.

Specified by:

getBackground in interface Component

Overrides:

getBackground in class AbstractComponent

Returns:

The background color of the component.

setBackground

public void setBackground(Color background)

Sets the background color.

Specified by:

setBackground in interface Component

Overrides:

setBackground in class AbstractComponent

Parameters:

background - The new background color of the component.

getForeground

public Color getForeground()

Gets the foreground (text) color.

Specified by:

getForeground in interface Component

Overrides:

getForeground in class AbstractComponent

Returns:

The foreground of the component.

setForeground

public void setForeground(Color foreground)

Sets the foreground (text) color.

Specified by:

setForeground in interface Component

Overrides:

setForeground in class AbstractComponent

Parameters:

foreground - The new foreground color of the component.

getText

public java.lang.String getText()

Sets the current value inside the input box. Handy if you are using this component unbound.

setText

public void setText(java.lang.String text)

Sets the text in the component.

setFocused

public void setFocused(boolean newValue)

Sets the input focus to this component.

Specified by:

setFocused in interface Component

Overrides:

setFocused in class AbstractComponent

Parameters:

newValue - True if the component is to be focused.

isConvertToLowerCase

public boolean isConvertToLowerCase()

setConvertToLowerCase

public void setConvertToLowerCase(boolean convertToLowerCase)

isConvertToUpperCase

public boolean isConvertToUpperCase()

setConvertToUpperCase

public void setConvertToUpperCase(boolean convertToUpperCase)

applyContext

public void applyContext()

Specified by:

applyContext in interface Precreation