ItemChip (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.webchips.AbstractChip
- - de.hybris.platform.hmc.ItemChip

All Implemented Interfaces:

ComposedChip, ToolbarProvider, Chip, Serializable, Cloneable

Direct Known Subclasses:

GenericItemChip
```
public abstract class ItemChip
extends AbstractChip
implements ComposedChip, ToolbarProvider
```
This is a generell chip for an item editor. It creates a new window in the constructor as its parent.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLOSE`
`static String`	`COPY`
`static String`	`DELETE_AND_CLOSE`
`protected EditorNode`	`editorNode`
`static String`	`REMOVE_FAILEDACCESS`
`static String`	`SAVE`
`static String`	`SAVE_AND_CLOSE`
`protected Item`	`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
Modifier	Constructor and Description
`protected`	`ItemChip(EditorNode node, DisplayState displayState, Chip parent, Item item)`
	`ItemChip(EditorNode node, DisplayState displayState, Item item)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkValid()` Gives the chip the possibility to check if its objects are still valid
`void`	`close()`
`void`	`copyItemToClipboard()`
`protected abstract AbstractEditorMenuChip`	`createEditor()`
`AbstractToolbarChip`	`createFooter()`
`abstract AbstractToolbarChip`	`createToolbar()`
`List`	`getChildren()`
`AbstractEditorMenuChip`	`getEditor()`
`abstract ItemEditorContext`	`getEditorContext()`
`EditorNode`	`getEditorNode()`
`GenericEssentialsEditorChip`	`getEssentials()`
`AbstractToolbarChip`	`getFooter()`
`Item`	`getItem()`
`ComposedType`	`getItemType()` In case of an ItemCreatorChip override this method and return the desired type of the new item.
`String`	`getItemTypeCode()`
`String`	`getJSPURI()` Returns the URI of the JSP that this chip wants to use.
`Map`	`getLockedAttributes()`
`String`	`getModalAttribute()`
`Language`	`getModalLanguage()` Returns the modal opener language, if one was set.
`ItemChip`	`getModalOpener()`
`String`	`getPresetAttributeName()`
`AbstractToolbarChip`	`getToolbar()`
`boolean`	`hasEssentials()`
`boolean`	`hasFooter()`
`void`	`initialize()`
`boolean`	`isLocked(String attributeQualifier)`
`boolean`	`isPartOf()`
`abstract void`	`performSave()`
`void`	`processEvents(Map events)` Handles all incoming requests for this chip.
`protected void`	`readInitialValues()`
`void`	`reload()`
`void`	`save()`
`void`	`setEssentials(GenericEssentialsEditorChip chip)`
`protected void`	`setItem(Item item)`
`void`	`setItemType(ComposedType itemType)`
`void`	`setLockedAttributes(Map attributes)`
`void`	`setModalReference(ItemChip openerItemChip, String openerAttributeQualifier)` Sets the ItemChip which opened this creator and the attributequalifier of the item.
`void`	`setModalReference(ItemChip openerItemChip, String openerAttributeQualifier, Language openerLanguage)` Sets the ItemChip which opened this creator, the attributequalifier of the item and the language, if it is a localized attribute.
`void`	`setPartOf(boolean partOf)`
`void`	`setPresetAttributeName(String presetAttributeName)`
`void`	`setToolbar(AbstractToolbarChip toolbarChip)`
`abstract void`	`showEditor()` Shows the editor for the item.

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, 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
addEventListener, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

- Field Detail
  - CLOSE
```
public static final String CLOSE
```
    See Also:
    
    Constant Field Values
  - SAVE
```
public static final String SAVE
```
    See Also:
    
    Constant Field Values
  - SAVE_AND_CLOSE
```
public static final String SAVE_AND_CLOSE
```
    See Also:
    
    Constant Field Values
  - DELETE_AND_CLOSE
```
public static final String DELETE_AND_CLOSE
```
    See Also:
    
    Constant Field Values
  - REMOVE_FAILEDACCESS
```
public static final String REMOVE_FAILEDACCESS
```
    See Also:
    
    Constant Field Values
  - COPY
```
public static final String COPY
```
    See Also:
    
    Constant Field Values
  - theItem
```
protected Item theItem
```
  - editorNode
```
protected final EditorNode editorNode
```
- Constructor Detail
  - ItemChip
```
public ItemChip(EditorNode node,
                DisplayState displayState,
                Item item)
```
  - ItemChip
```
protected ItemChip(EditorNode node,
                   DisplayState displayState,
                   Chip parent,
                   Item item)
```
- Method Detail
  - getEditorContext
```
public abstract ItemEditorContext getEditorContext()
```
  - getItem
```
public Item getItem()
```
  - setItem
```
protected void setItem(Item item)
```
  - getItemType
```
public ComposedType getItemType()
```
    In case of an ItemCreatorChip override this method and return the desired type of the new item.
  - getItemTypeCode
```
public String getItemTypeCode()
```
  - setItemType
```
public void setItemType(ComposedType itemType)
```
  - getToolbar
```
public final AbstractToolbarChip getToolbar()
```
    Specified by:
    
    getToolbar in interface ToolbarProvider
  - setToolbar
```
public final void setToolbar(AbstractToolbarChip toolbarChip)
```
    Since:
    
    3.0 M2
  - getFooter
```
public final AbstractToolbarChip getFooter()
```
  - hasFooter
```
public boolean hasFooter()
```
  - getEditor
```
public final AbstractEditorMenuChip getEditor()
```
  - setEssentials
```
public final void setEssentials(GenericEssentialsEditorChip chip)
```
  - hasEssentials
```
public final boolean hasEssentials()
```
  - getEssentials
```
public final GenericEssentialsEditorChip getEssentials()
```
  - showEditor
```
public abstract void showEditor()
```
    Shows the editor for the item. This method is abstract because subclasses have to specify the single elements of the editor, to set via createToolbar(), createEditor(), {link #setEssentials(SpecialSaveChip)}. Here the window to get via (@link #getWindow()} has to be configured and opened too.
  - performSave
```
public abstract void performSave()
```
  - save
```
public final void save()
```
  - close
```
public void close()
```
  - copyItemToClipboard
```
public void copyItemToClipboard()
```
    Since:
    
    3.00 (beta1)
  - initialize
```
public void initialize()
```
  - reload
```
public void reload()
```
  - readInitialValues
```
protected void readInitialValues()
```
  - getChildren
```
public List getChildren()
```
    Specified by:
    
    getChildren in interface ComposedChip
  - getJSPURI
```
public String getJSPURI()
```
    Description copied from interface: Chip
    
    Returns the URI of the JSP that this chip wants to use.
    
    Specified by:
    
    getJSPURI in interface Chip
  - 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)
    
    Specified by:
    
    processEvents in interface Chip
  - checkValid
```
public void checkValid()
```
    Gives the chip the possibility to check if its objects are still valid
    
    Specified by:
    
    checkValid in interface Chip
    
    Overrides:
    
    checkValid in class AbstractChip
  - setLockedAttributes
```
public void setLockedAttributes(Map attributes)
```
  - getLockedAttributes
```
public Map getLockedAttributes()
```
  - isLocked
```
public boolean isLocked(String attributeQualifier)
```
  - setPresetAttributeName
```
public void setPresetAttributeName(String presetAttributeName)
```
    Parameters:
    
    presetAttributeName -
  - getPresetAttributeName
```
public String getPresetAttributeName()
```
  - isPartOf
```
public boolean isPartOf()
```
  - setPartOf
```
public void setPartOf(boolean partOf)
```
    Parameters:
    
    partOf -
  - getModalOpener
```
public ItemChip getModalOpener()
```
    Returns:
    
    Returns the openerItemChip.
  - getModalLanguage
```
public Language getModalLanguage()
```
    Returns the modal opener language, if one was set.
    
    Returns:
    
    the modal opener language
    
    Since:
    
    1.31
  - setModalReference
```
public void setModalReference(ItemChip openerItemChip,
                              String openerAttributeQualifier)
```
    Sets the ItemChip which opened this creator and the attributequalifier of the item.
    
    Parameters:
    
    openerItemChip - the ItemChip from which this create chip has been opened
    
    openerAttributeQualifier - the qualifier of the attribute for which a new item is to be created
  - setModalReference
```
public void setModalReference(ItemChip openerItemChip,
                              String openerAttributeQualifier,
                              Language openerLanguage)
```
    Sets the ItemChip which opened this creator, the attributequalifier of the item and the language, if it is a localized attribute.
    
    Parameters:
    
    openerItemChip - the ItemChip from which this create chip has been opened
    
    openerAttributeQualifier - the qualifier of the attribute for which a new item is to be created
    
    openerLanguage - the Language for which to create the item (if the attribute is localizable, may be null if not)
    
    Since:
    
    1.31
  - getModalAttribute
```
public String getModalAttribute()
```
    Returns:
    
    Returns the qualifier of the AttributeDescriptor, which is edited with this itemchip.
  - createFooter
```
public AbstractToolbarChip createFooter()
```
  - createToolbar
```
public abstract AbstractToolbarChip createToolbar()
```
    Specified by:
    
    createToolbar in interface ToolbarProvider
  - createEditor
```
protected abstract AbstractEditorMenuChip createEditor()
```
  - getEditorNode
```
public EditorNode getEditorNode()
```

Class ItemChip

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

CLOSE

SAVE

SAVE_AND_CLOSE

DELETE_AND_CLOSE

REMOVE_FAILEDACCESS

COPY

theItem

editorNode

Constructor Detail

ItemChip

ItemChip

Method Detail

getEditorContext

getItem

setItem

getItemType

getItemTypeCode

setItemType

getToolbar

setToolbar

getFooter

hasFooter

getEditor

setEssentials

hasEssentials

getEssentials

showEditor

performSave

save

close

copyItemToClipboard

initialize

reload

readInitialValues

getChildren

getJSPURI

processEvents

checkValid

setLockedAttributes

getLockedAttributes

isLocked

setPresetAttributeName

getPresetAttributeName

isPartOf

setPartOf

getModalOpener

getModalLanguage

setModalReference

setModalReference

getModalAttribute

createFooter

createToolbar

createEditor

getEditorNode