de.hybris.platform.hmc.generic

Class GenericItemChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.ItemChip

de.hybris.platform.hmc.generic.GenericItemChip

All Implemented Interfaces:

ComposedChip, ToolbarProvider, Chip, Serializable, Cloneable

Direct Known Subclasses:

GenericItemCreatorChip, OrganizerItemChip

public class GenericItemChip
extends ItemChip

GenericItemChip is used to generically edit items. The editor can be configured (see generic package).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GenericItemChip.GenericItemEditorContext The editor context implementation for non-wizard items.
protected class	GenericItemChip.GenericWizardEditorContext The editor context implementation for wizard items.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPEN_ORGANIZER
static String	REFRESH
static String	VALIDATE

Fields inherited from class de.hybris.platform.hmc.ItemChip

CLOSE, COPY, DELETE_AND_CLOSE, editorNode, REMOVE_FAILEDACCESS, SAVE, SAVE_AND_CLOSE, theItem

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
GenericItemChip(EditorNode node, DisplayState displayState, Chip parent, Item item, boolean asWizard)
GenericItemChip(EditorNode node, DisplayState displayState, ComposedType type, Item item, boolean asWizard) Creates a new item editor chip.

Method Summary

Modifier and Type	Method and Description
protected void	addItemActionToToolbar(ItemActionChip actionChip)
protected void	addWizardButton(String buttonName, AbstractToolbarActionChip actionChip)
protected void	clearAllErrors()
boolean	computeChanges()
protected void	configureItemToolbar(AbstractToolbarChip toolBar, DisplayState displayState)
protected void	configureSingletonToolbar(AbstractToolbarChip toolBar, DisplayState displayState)
protected void	configureWizardToolbar(AbstractToolbarChip toolBar, DisplayState displayState)
protected AbstractEditorMenuChip	createEditor()
AbstractToolbarChip	createFooter() Creates footer for wizard items.
AbstractToolbarChip	createToolbar()
List	getActionChips()
protected Map	getAllAttributeValues()
AttributeChip	getAttributeChip(String qualifier)
protected Map	getAttributeChips()
protected Map	getAttributeValues()
protected Collection	getChangeIndicatorChips() Collects all children of this chip which are ChangeIndicators and returns them..
String	getCloseErrorMessage()
ItemEditorContext	getEditorContext()
protected ProgressToolbarActionChip	getProgressBar()
protected RefreshIntervalToolbarActionChip	getRefreshChip()
SpecialEditor	getSpecialEditor(String qualifier)
protected Map	getSpecialSaveChips() Collects all children of this chip which are SpecialSaveChips and returns them in a Map [attributequalifier -> chip].
WizardBusinessItem	getWizardBusinessItem()
protected AbstractToolbarActionChip	getWizardButton(String buttonName)
protected Map	getWizardButtons()
void	initialize() Superclass method override to initialize wizard business item after this item chip has been initialized.
protected boolean	isShownExternally()
boolean	isSingleton()
boolean	isWizard()
void	openOrganizer()
void	performSave()
protected void	performSave(Map currentValues, Map initialValues, Map specialEditors)
void	refresh() Superclass method override to call WizardBusinessItem.pollStatus(WizardEditorContext).
void	registerActionChip(ItemActionChip actionChip)
void	reload()
protected void	reload(Collection attributeNames)
protected void	reload(String attributeName)
protected void	setProgressBar(ProgressToolbarActionChip chip)
void	showEditor() Shows the editor for the item.
void	showEditor(boolean calledFromMainWindow)
void	validateAndSave(String fromTab, String toTab)

Methods inherited from class de.hybris.platform.hmc.ItemChip

checkValid, close, copyItemToClipboard, getChildren, getEditor, getEditorNode, getEssentials, getFooter, getItem, getItemType, getItemTypeCode, getJSPURI, getLockedAttributes, getModalAttribute, getModalLanguage, getModalOpener, getPresetAttributeName, getToolbar, hasEssentials, hasFooter, isLocked, isPartOf, processEvents, readInitialValues, save, setEssentials, setItem, setItemType, setLockedAttributes, setModalReference, setModalReference, setPartOf, setPresetAttributeName, setToolbar

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, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, 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

addEventListener, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

Field Detail

REFRESH

public static final String REFRESH

See Also:

Constant Field Values

OPEN_ORGANIZER

public static final String OPEN_ORGANIZER

See Also:

Constant Field Values

VALIDATE

public static final String VALIDATE

See Also:

Constant Field Values

Constructor Detail

GenericItemChip

public GenericItemChip(EditorNode node,
                       DisplayState displayState,
                       ComposedType type,
                       Item item,
                       boolean asWizard)

Creates a new item editor chip.

GenericItemChip

public GenericItemChip(EditorNode node,
                       DisplayState displayState,
                       Chip parent,
                       Item item,
                       boolean asWizard)

Method Detail

initialize

public void initialize()

Superclass method override to initialize wizard business item after this item chip has been initialized.

Overrides:

initialize in class ItemChip

createEditor

protected AbstractEditorMenuChip createEditor()

Specified by:

createEditor in class ItemChip

isWizard

public boolean isWizard()

getWizardBusinessItem

public WizardBusinessItem getWizardBusinessItem()

isSingleton

public boolean isSingleton()

getEditorContext

public ItemEditorContext getEditorContext()

Specified by:

getEditorContext in class ItemChip

getActionChips

public List getActionChips()

registerActionChip

public void registerActionChip(ItemActionChip actionChip)

addItemActionToToolbar

protected void addItemActionToToolbar(ItemActionChip actionChip)

Since:

3.0 M2

configureSingletonToolbar

protected void configureSingletonToolbar(AbstractToolbarChip toolBar,
                                         DisplayState displayState)

configureItemToolbar

protected void configureItemToolbar(AbstractToolbarChip toolBar,
                                    DisplayState displayState)

configureWizardToolbar

protected void configureWizardToolbar(AbstractToolbarChip toolBar,
                                      DisplayState displayState)

getRefreshChip

protected RefreshIntervalToolbarActionChip getRefreshChip()

isShownExternally

protected boolean isShownExternally()

createFooter

public AbstractToolbarChip createFooter()

Creates footer for wizard items.

Overrides:

createFooter in class ItemChip

createToolbar

public AbstractToolbarChip createToolbar()

Specified by:

createToolbar in interface ToolbarProvider

Specified by:

createToolbar in class ItemChip

showEditor

public void showEditor()

Description copied from class: ItemChip

Shows the editor for the item. This method is abstract because subclasses have to specify the single elements of the editor, to set via ItemChip.createToolbar(), ItemChip.createEditor(), {link #setEssentials(SpecialSaveChip)}. Here the window to get via (@link #getWindow()} has to be configured and opened too.

Specified by:

showEditor in class ItemChip

showEditor

public void showEditor(boolean calledFromMainWindow)

Since:

2.10

getAttributeValues

protected Map getAttributeValues()
                          throws JaloBusinessException

Returns:

Map of all attribute values excluding those that are editable, have a useful value or are accessible. Mapping: AttribueQualifier -> AttributeValue Note: AttributeQualifier should always be treated caseinsensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other caseinsensitive implementations.

Throws:

JaloBusinessException

getAllAttributeValues

protected Map getAllAttributeValues()
                             throws JaloBusinessException

Returns:

Map of all attribute values, not regarding if they are editable, have a useful value or are accessible. Mapping: AttribueQualifier -> AttributeValue Note: AttributeQualifier should always be treated caseinsensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other caseinsensitive implementations.

Throws:

JaloBusinessException

performSave

public void performSave()

Specified by:

performSave in class ItemChip

performSave

protected void performSave(Map currentValues,
                           Map initialValues,
                           Map specialEditors)

getSpecialSaveChips

protected Map getSpecialSaveChips()

Collects all children of this chip which are SpecialSaveChips and returns them in a Map [attributequalifier -> chip].

Returns:

all children of this chip which are SpecialSaveChips

getChangeIndicatorChips

protected Collection getChangeIndicatorChips()

Collects all children of this chip which are ChangeIndicators and returns them..

Returns:

all children of this chip which are ChangeIndicators

getSpecialEditor

public SpecialEditor getSpecialEditor(String qualifier)

getAttributeChips

protected Map getAttributeChips()

getAttributeChip

public AttributeChip getAttributeChip(String qualifier)

validateAndSave

public void validateAndSave(String fromTab,
                            String toTab)

refresh

public void refresh()

Superclass method override to call WizardBusinessItem.pollStatus(WizardEditorContext).

Overrides:

refresh in class AbstractChip

reload

public void reload()

Overrides:

reload in class ItemChip

reload

protected void reload(String attributeName)

reload

protected void reload(Collection attributeNames)

clearAllErrors

protected void clearAllErrors()

openOrganizer

public void openOrganizer()

getProgressBar

protected ProgressToolbarActionChip getProgressBar()

setProgressBar

protected void setProgressBar(ProgressToolbarActionChip chip)

getWizardButtons

protected Map getWizardButtons()

addWizardButton

protected void addWizardButton(String buttonName,
                               AbstractToolbarActionChip actionChip)

getWizardButton

protected AbstractToolbarActionChip getWizardButton(String buttonName)

getCloseErrorMessage

public String getCloseErrorMessage()

computeChanges

public boolean computeChanges()

Returns:

true if there any changes to the chips

Since:

2.20 (pulled up from OrganizerItemChip)