com.hybris.cockpitng.editors.impl

Class AbstractTextBasedEditorRenderer<T>

java.lang.Object

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

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

All Implemented Interfaces:

CockpitEditorRenderer<T>

Direct Known Subclasses:

AbstractDateTimeEditor, AbstractDecimalEditor, AbstractIntegralEditor, AbstractTextEditor, DefaultBigDecimalEditor, DefaultBigIntegerEditor

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

Abstract text based Editor that all "single input" fields should extend.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SETTING_INPUT_INSTANT

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

HEADER_LABEL_TOOLTIP, ON_ADD_EVENT, ON_DELETE_EVENT

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

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor and Description
AbstractTextBasedEditorRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	clearInvalidInputAndNotify(EditorListener<T> listener, org.zkoss.zul.impl.InputElement editorView)
protected abstract T	coerceFromString(org.zkoss.zul.impl.InputElement editorView, String text) Converts string value to a real value.
protected abstract T	getRawValue(org.zkoss.zul.impl.InputElement editorView) Extracts value of the given editor component.
protected void	handleChangeEvent(EditorListener<T> listener, org.zkoss.zul.impl.InputElement editorView)
protected void	handleChangeEvent(EditorListener<T> listener, T value)
protected void	handleChangingEvent(EditorListener<T> listener, org.zkoss.zul.impl.InputElement editorView, String stringValue)
protected void	handleReadOnly(EditorContext<T> context, org.zkoss.zul.impl.InputElement editorView) Utility method that assures proper handling of readonly/disabled attributes across different browsers.
protected boolean	hasInvalidInput(org.zkoss.zul.impl.InputElement editorView)
protected void	initViewComponent(org.zkoss.zul.impl.InputElement editorView, EditorContext<T> context, EditorListener<T> listener) Adds event listeners to this editor component, parses the parameter for initial value etc.
boolean	isPrimitive()
protected void	onCancelEvent(EditorListener<T> listener, org.zkoss.zul.impl.InputElement editorView, T initialValue) Method called when the user cancelled his input.
protected void	onChangeEvent(EditorListener<T> listener, org.zkoss.zul.impl.InputElement editorView) Method called when the editor value is changed and the editor is not focused anymore.
protected void	onChangingEvent(EditorListener<T> listener, org.zkoss.zul.impl.InputElement editorView, org.zkoss.zk.ui.event.InputEvent event) Method called when something changed in the editor, for example every 1 sec while typing something
protected void	onFocusEvent(org.zkoss.zul.impl.InputElement editorView, String initialEditText) Method called when the user focuses the Editor.
protected void	onOkEvent(EditorListener<T> listener, org.zkoss.zul.impl.InputElement editorView) Method called when the editor value is set
protected abstract void	setRawValue(org.zkoss.zul.impl.InputElement editorView, T rawValue) Sets the value to the given editor component.

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

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

render

Field Detail

SETTING_INPUT_INSTANT

public static final String SETTING_INPUT_INSTANT

See Also:

Constant Field Values

Constructor Detail

AbstractTextBasedEditorRenderer

public AbstractTextBasedEditorRenderer()

Method Detail

initViewComponent

protected void initViewComponent(org.zkoss.zul.impl.InputElement editorView,
                                 EditorContext<T> context,
                                 EditorListener<T> listener)

Adds event listeners to this editor component, parses the parameter for initial value etc.

Parameters:

editorView - the editor component previously created in overridden method CockpitEditorRenderer.render(org.zkoss.zk.ui.Component, com.hybris.cockpitng.editors.EditorContext, com.hybris.cockpitng.editors.EditorListener)

context - the editor context

onChangingEvent

protected void onChangingEvent(EditorListener<T> listener,
                               org.zkoss.zul.impl.InputElement editorView,
                               org.zkoss.zk.ui.event.InputEvent event)

Method called when something changed in the editor, for example every 1 sec while typing something

Parameters:

editorView - the Editor

event -

onChangeEvent

protected void onChangeEvent(EditorListener<T> listener,
                             org.zkoss.zul.impl.InputElement editorView)

Method called when the editor value is changed and the editor is not focused anymore.

Parameters:

listener -

editorView - the Editor

onOkEvent

protected void onOkEvent(EditorListener<T> listener,
                         org.zkoss.zul.impl.InputElement editorView)

Method called when the editor value is set

Parameters:

listener -

editorView - the Editor

onCancelEvent

protected void onCancelEvent(EditorListener<T> listener,
                             org.zkoss.zul.impl.InputElement editorView,
                             T initialValue)

Method called when the user cancelled his input.

Parameters:

listener -

editorView - the Editor

onFocusEvent

protected void onFocusEvent(org.zkoss.zul.impl.InputElement editorView,
                            String initialEditText)

Method called when the user focuses the Editor.

Parameters:

editorView - the Editor

initialEditText -

handleChangeEvent

protected void handleChangeEvent(EditorListener<T> listener,
                                 org.zkoss.zul.impl.InputElement editorView)

handleChangeEvent

protected void handleChangeEvent(EditorListener<T> listener,
                                 T value)

handleChangingEvent

protected void handleChangingEvent(EditorListener<T> listener,
                                   org.zkoss.zul.impl.InputElement editorView,
                                   String stringValue)

clearInvalidInputAndNotify

protected void clearInvalidInputAndNotify(EditorListener<T> listener,
                                          org.zkoss.zul.impl.InputElement editorView)

hasInvalidInput

protected boolean hasInvalidInput(org.zkoss.zul.impl.InputElement editorView)

handleReadOnly

protected void handleReadOnly(EditorContext<T> context,
                              org.zkoss.zul.impl.InputElement editorView)

Utility method that assures proper handling of readonly/disabled attributes across different browsers.

Parameters:

context - editor context

editorView - the view of the editor

setRawValue

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

Sets the value to the given editor component.

Parameters:

editorView - the underlying editor component

rawValue - the value

getRawValue

protected abstract T getRawValue(org.zkoss.zul.impl.InputElement editorView)

Extracts value of the given editor component.

Parameters:

editorView - the underlying editor component

Returns:

the value

coerceFromString

protected abstract T coerceFromString(org.zkoss.zul.impl.InputElement editorView,
                                      String text)

Converts string value to a real value.

Parameters:

editorView - the underlying editor component

text - the string vale

Returns:

the value

isPrimitive

public boolean isPrimitive()

Returns:

true if editor has been created for primitive type like int/boolean/decimal/byte/short/long/char. Otherwise it returns false.