Package com.hybris.cockpitng.editors

Class EditorContext<T>

java.lang.Object

com.hybris.cockpitng.core.context.impl.DefaultCockpitContext

com.hybris.cockpitng.editors.EditorContext<T>

All Implemented Interfaces:

CockpitContext, java.io.Serializable

public class EditorContext<T>
extends DefaultCockpitContext

A context object given to a cockpit editor to render itself.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EditorContext(T initialValue, EditorDefinition definition, java.util.Map<java.lang.String,java.lang.Object> parameters, java.util.Map<java.lang.String,java.lang.Object> labels, java.util.Set<java.util.Locale> readableLocales, java.util.Set<java.util.Locale> writableLocales)

Method Summary

Modifier and Type	Method	Description
static <T> EditorContext<T>	clone(EditorContext<T> context, T initialValue)
java.lang.String	getCode()
EditorDefinition	getDefinition()
java.lang.String	getEditorLabel()
T	getInitialValue()
java.lang.String	getLabel(java.lang.String key)
java.lang.String	getLabel(java.lang.String key, java.lang.Object[] args)
java.util.Map<java.lang.String,java.lang.Object>	getLabels()
<K> K	getParameterAs(java.lang.String key)
java.util.Set<java.util.Locale>	getReadableLocales()
java.lang.String	getResourceUrl(java.lang.String relativeUrl)
java.lang.String	getSuccessNotificationId()
java.lang.String	getTooltiptext()
java.lang.String	getValueType()	Value type as specified in the editor definition or for the concrete instance of the editor.
java.lang.String	getViewSrc()
java.util.Set<java.util.Locale>	getWritableLocales()
boolean	isEditable()
boolean	isOptional()
boolean	isOrdered()
boolean	isPartOf()
boolean	isPrimitive()
void	setEditable(boolean editable)
void	setEditorLabel(java.lang.String editorLabel)
void	setOptional(boolean optional)
void	setOrdered(boolean ordered)
void	setPartOf(boolean partOf)
void	setPrimitive(boolean primitive)
void	setSuccessNotificationId(java.lang.String successNotificationId)
void	setTooltiptext(java.lang.String tooltiptext)
void	setValueType(java.lang.String valueType)

Methods inherited from class com.hybris.cockpitng.core.context.impl.DefaultCockpitContext

addAllParameters, clearParameters, containsParameter, getParameter, getParameterKeys, getParameters, removeParameter, setParameter, setParameters

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.core.context.CockpitContext

getParameterAsBoolean

Constructor Detail

EditorContext

public EditorContext(T initialValue,
                     EditorDefinition definition,
                     java.util.Map<java.lang.String,java.lang.Object> parameters,
                     java.util.Map<java.lang.String,java.lang.Object> labels,
                     java.util.Set<java.util.Locale> readableLocales,
                     java.util.Set<java.util.Locale> writableLocales)

Method Detail

getViewSrc

public java.lang.String getViewSrc()

getInitialValue

public T getInitialValue()

getParameterAs

public <K> K getParameterAs(java.lang.String key)

getLabel

public java.lang.String getLabel(java.lang.String key)

getLabel

public java.lang.String getLabel(java.lang.String key,
                                 java.lang.Object[] args)

getResourceUrl

public java.lang.String getResourceUrl(java.lang.String relativeUrl)

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean editable)

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean optional)

getValueType

public java.lang.String getValueType()

Value type as specified in the editor definition or for the concrete instance of the editor.

Returns:

value type as specified in the editor definition or for the concrete instance of the editor

setValueType

public void setValueType(java.lang.String valueType)

getCode

public java.lang.String getCode()

Returns:

editor code as specified in the definition

getDefinition

public EditorDefinition getDefinition()

getLabels

public java.util.Map<java.lang.String,java.lang.Object> getLabels()

Returns:

the labels

getReadableLocales

public java.util.Set<java.util.Locale> getReadableLocales()

getWritableLocales

public java.util.Set<java.util.Locale> getWritableLocales()

getEditorLabel

public java.lang.String getEditorLabel()

setEditorLabel

public void setEditorLabel(java.lang.String editorLabel)

isOrdered

public boolean isOrdered()

setOrdered

public void setOrdered(boolean ordered)

isPartOf

public boolean isPartOf()

setPartOf

public void setPartOf(boolean partOf)

isPrimitive

public boolean isPrimitive()

setPrimitive

public void setPrimitive(boolean primitive)

getSuccessNotificationId

public java.lang.String getSuccessNotificationId()

setSuccessNotificationId

public void setSuccessNotificationId(java.lang.String successNotificationId)

getTooltiptext

public java.lang.String getTooltiptext()

setTooltiptext

public void setTooltiptext(java.lang.String tooltiptext)

clone

public static <T> EditorContext<T> clone(EditorContext<T> context,
                                         T initialValue)