de.hybris.platform.hmc.attribute

Class ReferenceAttributeEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

de.hybris.platform.hmc.attribute.ReferenceAttributeEditorChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

AutocompleteReferenceEditorChip, GenericReferenceEditorChip, SelectReferenceEditorChip

public abstract class ReferenceAttributeEditorChip
extends AbstractAttributeEditorChip

This is an editor chip for an reference attribute of an item.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLEAR
static String	COPY
static String	CREATABLE_KEY
static String	CREATE
static String	EDITABLE_KEY
static String	OPEN_EDITOR
static String	OPEN_EDITOR_INTERNAL
static String	OPEN_SEARCH
static String	PASTE

Fields inherited from class de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

CUSTOM, DEFAULT_HEIGHT

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
ReferenceAttributeEditorChip(DisplayState displayState, Chip parent)
ReferenceAttributeEditorChip(DisplayState displayState, Chip parent, ComposedType type)
ReferenceAttributeEditorChip(DisplayState displayState, Chip parent, ComposedType type, Item value)

Method Summary

Modifier and Type	Method and Description
void	addCreationPreset(HMCHelper.AttributePreset preset)
void	addSearchPreset(HMCHelper.AttributePreset preset)
boolean	canCreate()
boolean	canPaste()
protected Item	getAssignableItemFromClipboard()
Collection<HMCHelper.AttributePreset>	getCreationPresets()
protected ReferenceEditorNode	getEditorNode()
protected ComposedType	getItemType()
List	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
String	getNoSelectionKey()
ComposedType	getPresetSearchType() Get the preset searchtype which will be used when the search is opened.
Collection<HMCHelper.AttributePreset>	getSearchPresets()
String	getSelectedItemAsString()
boolean	hasItem()
boolean	isAttributeTypeReadable()
boolean	isAutoPerform()
boolean	isCreatable()
boolean	isElementReadable()
boolean	isElementWriteable()
boolean	isPartOf()
boolean	isRefreshAfterSelect() Will a refresh be performed after a value was selected?
void	openEditor()
void	openEditor(boolean external)
void	processEvents(Map events) Handles all incoming requests for this chip.
void	setCreatable(boolean creatable)
void	setItemType(ComposedType type)
void	setNoSelectionKey(String key)
void	setParameters(Map map) Sets the parameters which where provided by the xml configuration.
void	setPresetSearchType(String searchTypeCode) Set the preset searchtype which will be used when the search is opened.
void	setRefreshAfterSelect(boolean refresh) Sets if a refresh has to be triggered after a value was selected.
void	setValue(Object value)

Methods inherited from class de.hybris.platform.hmc.attribute.AbstractAttributeEditorChip

addAttributeValueChangeListener, checkValid, clearError, containsValidValue, convertAndSetValue, convertValue, getAttributeChip, getAttributeDescriptor, getAttributeValueChangeListeners, getEditorType, getFieldID, getHeight, getInitialValue, getLastInvalidValue, getMaxLength, getParameters, getParentEditorChip, getProposedUniqueName, getValue, getWidth, isAjaxUpdatable, isChanged, isEditable, isInitialized, isOptional, notifyAttributeValueChangeListeners, removeAttributeValueChangeListener, setAttributeDescriptor, setEditable, setError, setFieldID, setHeight, setInitialValue, setMaxLength, setOptional, setValidValue, setWidth, valuesAreDifferent

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

getJSPURI

Field Detail

CREATE

public static final String CREATE

See Also:

Constant Field Values

COPY

public static final String COPY

See Also:

Constant Field Values

PASTE

public static final String PASTE

See Also:

Constant Field Values

OPEN_EDITOR

public static final String OPEN_EDITOR

See Also:

Constant Field Values

OPEN_EDITOR_INTERNAL

public static final String OPEN_EDITOR_INTERNAL

See Also:

Constant Field Values

OPEN_SEARCH

public static final String OPEN_SEARCH

See Also:

Constant Field Values

CLEAR

public static final String CLEAR

See Also:

Constant Field Values

EDITABLE_KEY

public static final String EDITABLE_KEY

See Also:

Constant Field Values

CREATABLE_KEY

public static final String CREATABLE_KEY

See Also:

Constant Field Values

Constructor Detail

ReferenceAttributeEditorChip

public ReferenceAttributeEditorChip(DisplayState displayState,
                                    Chip parent,
                                    ComposedType type)

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

type - The type of the new value, must not be null.

ReferenceAttributeEditorChip

public ReferenceAttributeEditorChip(DisplayState displayState,
                                    Chip parent)

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

ReferenceAttributeEditorChip

public ReferenceAttributeEditorChip(DisplayState displayState,
                                    Chip parent,
                                    ComposedType type,
                                    Item value)

Parameters:

displayState - The current displaystate this chip belongs to.

parent - The composition parent chip.

type - The type of the new value, must not be null.

Method Detail

setNoSelectionKey

public void setNoSelectionKey(String key)

Since:

3.0

getNoSelectionKey

public String getNoSelectionKey()

Since:

3.0

getItemType

protected ComposedType getItemType()

hasItem

public boolean hasItem()

getSelectedItemAsString

public String getSelectedItemAsString()

isElementReadable

public boolean isElementReadable()

Returns:

true if the referenced item is null or readable.

isAttributeTypeReadable

public boolean isAttributeTypeReadable()

Since:

2.30 beta

isElementWriteable

public boolean isElementWriteable()

Returns:

true if the referenced item is either null and createable or not null and writeable.

isPartOf

public boolean isPartOf()

getEditorNode

protected ReferenceEditorNode getEditorNode()

isAutoPerform

public boolean isAutoPerform()

Since:

2.20

getCreationPresets

public Collection<HMCHelper.AttributePreset> getCreationPresets()

Returns:

a Collection

Since:

2.20

getSearchPresets

public Collection<HMCHelper.AttributePreset> getSearchPresets()

Since:

2.20

addCreationPreset

public void addCreationPreset(HMCHelper.AttributePreset preset)

Parameters:

preset -

Since:

2.20

addSearchPreset

public void addSearchPreset(HMCHelper.AttributePreset preset)

Parameters:

preset -

Since:

2.20

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

getAssignableItemFromClipboard

protected Item getAssignableItemFromClipboard()

canPaste

public boolean canPaste()

canCreate

public boolean canCreate()

setItemType

public void setItemType(ComposedType type)

Parameters:

type -

openEditor

public void openEditor()

openEditor

public void openEditor(boolean external)

Since:

3.00 (beta1)

getMenuEntries

public List getMenuEntries()

Description copied from class: AbstractChip

Here you can specify what Actions you are able to perform at the moment. Should be overridden in sub classes.

Specified by:

getMenuEntries in interface Chip

Overrides:

getMenuEntries in class AbstractChip

Returns:

List of Actions;

Since:

2.30

See Also:

AbstractChip.getMenuEntries()

setPresetSearchType

public void setPresetSearchType(String searchTypeCode)

Set the preset searchtype which will be used when the search is opened.

Parameters:

searchTypeCode - the preset search type

getPresetSearchType

public ComposedType getPresetSearchType()

Get the preset searchtype which will be used when the search is opened.

Returns:

the preset search type

setParameters

public void setParameters(Map map)

Description copied from class: AbstractAttributeEditorChip

Sets the parameters which where provided by the xml configuration.

Overrides:

setParameters in class AbstractAttributeEditorChip

Parameters:

map - the parameters which where provided by the xml configuration.

setValue

public void setValue(Object value)

Overrides:

setValue in class AbstractAttributeEditorChip

Since:

3.0 M2

See Also:

AbstractAttributeEditorChip.setValue(java.lang.Object)

setRefreshAfterSelect

public void setRefreshAfterSelect(boolean refresh)

Sets if a refresh has to be triggered after a value was selected.

Parameters:

refresh - true for refresh after select, otherwise false

Since:

3.0-u2

isRefreshAfterSelect

public boolean isRefreshAfterSelect()

Will a refresh be performed after a value was selected?

Returns:

true if a refresh will be triggered, otherwise false

Since:

3.0-u2

isCreatable

public boolean isCreatable()

Returns:

the creatable

setCreatable

public void setCreatable(boolean creatable)

Parameters:

creatable - the creatable to set