Package com.hybris.cockpitng.editor.text

Class AbstractTextEditor<T>

java.lang.Object

com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer<T>

com.hybris.cockpitng.editors.impl.AbstractTextBasedEditorRenderer<T>

com.hybris.cockpitng.editor.text.AbstractTextEditor<T>

Type Parameters:

T - supported text classes: String, Character

All Implemented Interfaces:

CockpitEditorRenderer<T>

Direct Known Subclasses:

DefaultCharacterEditor, DefaultTextEditor

public abstract class AbstractTextEditor<T>
extends AbstractTextBasedEditorRenderer<T>

Field Summary

Fields inherited from class com.hybris.cockpitng.editors.impl.AbstractTextBasedEditorRenderer

SETTING_INPUT_INSTANT

Fields inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

HEADER_LABEL_TOOLTIP, ON_ADD_EVENT, ON_DELETE_EVENT, YW_EDITOR_AREA_LABEL_CONTAINER

Fields inherited from interface com.hybris.cockpitng.editors.CockpitEditorRenderer

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor	Description
AbstractTextEditor(java.lang.Class<T> valueType)

Method Summary

Modifier and Type	Method	Description
protected T	coerceFromString(org.zkoss.zul.impl.InputElement editorView, java.lang.String text)	Converts string value to a real value.
protected java.lang.String	convertToString(org.zkoss.zul.impl.InputElement editorView, T initialValue)	Converts component value to String
protected T	getRawValue(org.zkoss.zul.impl.InputElement viewComponent)	Extracts value of the given editor component.
protected void	initAdditionalParameters(org.zkoss.zul.Textbox editorView, EditorContext<T> context)	Additional initialization of ui component according to specified context
void	render(org.zkoss.zk.ui.Component parent, EditorContext<T> context, EditorListener<T> listener)	Creates a new editor component and attaches it to the specified Component component.
protected void	setRawValue(org.zkoss.zul.impl.InputElement viewComponent, T rawValue)	Sets the value to the given editor component.

Methods inherited from class com.hybris.cockpitng.editors.impl.AbstractTextBasedEditorRenderer

clearInvalidInputAndNotify, handleChangeEvent, handleChangeEvent, handleChangingEvent, handleReadOnly, hasInvalidInput, initViewComponent, isPrimitive, onCancelEvent, onChangeEvent, onChangingEvent, onFocusEvent, onOkEvent

Methods inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

extractEmbeddedEditor, extractEmbeddedType, findAncestorEditor, findEmbeddedEditors, getInitialEditString, getL10nDecorator

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTextEditor

public AbstractTextEditor(java.lang.Class<T> valueType)

Method Detail

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext<T> context,
                   EditorListener<T> listener)

Description copied from interface: CockpitEditorRenderer

Creates a new editor component and attaches it to the specified Component component.

Parameters:

parent - parent component the editor should be attached to

context - the context for the editor creation

listener - the listener to notify the rest of the world about value changes and other events

initAdditionalParameters

protected void initAdditionalParameters(org.zkoss.zul.Textbox editorView,
                                        EditorContext<T> context)

Additional initialization of ui component according to specified context

Parameters:

editorView - ui component

context - context

setRawValue

protected void setRawValue(org.zkoss.zul.impl.InputElement viewComponent,
                           T rawValue)

Description copied from class: AbstractTextBasedEditorRenderer

Sets the value to the given editor component.

Specified by:

setRawValue in class AbstractTextBasedEditorRenderer<T>

Parameters:

viewComponent - the underlying editor component

rawValue - the value

getRawValue

protected T getRawValue(org.zkoss.zul.impl.InputElement viewComponent)

Description copied from class: AbstractTextBasedEditorRenderer

Extracts value of the given editor component.

Specified by:

getRawValue in class AbstractTextBasedEditorRenderer<T>

Parameters:

viewComponent - the underlying editor component

Returns:

the value

coerceFromString

protected T coerceFromString(org.zkoss.zul.impl.InputElement editorView,
                             java.lang.String text)
                      throws org.zkoss.zk.ui.WrongValueException

Description copied from class: AbstractTextBasedEditorRenderer

Converts string value to a real value.

Specified by:

coerceFromString in class AbstractTextBasedEditorRenderer<T>

Parameters:

editorView - the underlying editor component

text - the string vale

Returns:

the value

Throws:

org.zkoss.zk.ui.WrongValueException

convertToString

protected java.lang.String convertToString(org.zkoss.zul.impl.InputElement editorView,
                                           T initialValue)

Converts component value to String

Parameters:

editorView - ui component

initialValue - vomponent value

Returns:

string value