AttributeChip (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.webchips.AbstractChip
- - de.hybris.platform.hmc.attribute.AttributeChip

All Implemented Interfaces:

Chip, Serializable, Cloneable, Comparable

Direct Known Subclasses:

LocalizableAttributeChip, NoAccessAttributeChip
```
public class AttributeChip
extends AbstractChip
implements Comparable
```
This is a display chip for editing attributes of an item. It provides a simple view for editing the value defined by the used editor. This editor can be set via setEditor(AbstractAttributeEditorChip) or can be generated by this class if the editor type is given in the constructor.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY_ATTRIBUTE_NAME` use this string to mark attribute names as being deliberately empty
`static String`	`KEEP_ALIVE` Event string for reading the select state.
`static String`	`SET_SELECTED` Event string for setting the select state.

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
`AttributeChip(DisplayState displayState, Chip parent, String attributeName, Type valueType)` Constructor for creating a new attribute chip for input of inheritable values.
`AttributeChip(DisplayState displayState, Chip parent, String attributeName, Type valueType, String editorType, Class editorClass)`
`AttributeChip(DisplayState displayState, Chip parent, String attributeName, Type valueType, String editorType, Class editorClass, Object initialValue)` Constructor for creating a new attribute chip for input of inheritable values.

Method Summary

All Methods Static Methods Instance 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`	`clearError()`
`int`	`compareTo(Object obj)` Compares AttributeChips by comparing their labels.
`protected AbstractAttributeEditorChip`	`createEditor()`
`static AbstractAttributeEditorChip`	`createEditor(DisplayState displayState, Chip parent, Type attributeType)`
`static AbstractAttributeEditorChip`	`createEditor(DisplayState displayState, Chip parent, Type attributeType, String editorType, Class customEditorClass, boolean isPartOf)`
`AttributeDescriptor`	`getAttributeDescriptor()` Gets the AttributeDescriptor Note: This is a hack.
`String`	`getAttributeQualifier()`
`Type`	`getAttributeType()`
`static String`	`getDefaultEditorType(Type type, JaloSession jaloSession)`
`static String`	`getDefaultEditorType(Type type, JaloSession jaloSession, AttributeDescriptor descriptor)`
`String`	`getDescription()`
`String`	`getDescriptionAttribute()`
`String`	`getDescriptionAttributeValue()` If an additional attribute was given (via xml configuration), this method returns the string representation of the attribute (if it is found in the enclosing item).
`AbstractAttributeEditorChip`	`getEditor()`
`Class`	`getEditorClass()`
`String`	`getEditorType()`
`Exception`	`getError()`
`String`	`getErrorText()`
`Object`	`getInitialValue()`
`protected Item`	`getItem()` Returns the item of the enclosing ItemChip (if there is one).
`String`	`getJSPURI()` Returns the URI of the JSP that this chip wants to use.
`String`	`getLabel()`
`int`	`getLabelWidth()`
`protected String`	`getProposedUniqueName()`
`String`	`getToolTip()`
`Object`	`getValue()`
`boolean`	`hasError()`
`boolean`	`hasErrorText()`
`protected void`	`initializeEditor()`
`boolean`	`isChanged()` Returns true if the value of this chip's editor has changed, i.e.
`boolean`	`isEditable()`
`boolean`	`isEncrypted()`
`boolean`	`isHideLabel()`
`boolean`	`isOptional()`
`boolean`	`isPartOf()`
`boolean`	`isRequired()`
`boolean`	`isSelected()`
`void`	`processEvents(Map<String,List<String>> events)` Handles all incoming requests for this chip.
`void`	`saveAttribute(AbstractAttributeEditorChip editorChip)`
`void`	`setDescription(String description)` Sets a description as hint for inputing a value like 'Enter a string'.
`void`	`setDescriptionAttribute(String attributeName)`
`void`	`setEditable(boolean editable)`
`void`	`setEditor(AbstractAttributeEditorChip editor)` Sets the editor which manages the input of the attribute value.
`void`	`setEditorClass(Class editorClass)`
`void`	`setEditorType(String editorType)`
`void`	`setEncrypted(boolean encrypted)`
`void`	`setError(Exception exception)`
`void`	`setErrorText(String txt)`
`void`	`setHideLabel(boolean hideLabel)`
`void`	`setInitialValue(Object initialValue)`
`void`	`setLabelWidth(int labelWidth)`
`void`	`setMaxLength(int maxLength)`
`void`	`setSelected(boolean staySelected)` Sets the selection state.
`void`	`setValue(Object value)`

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, 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

- Field Detail
  - KEEP_ALIVE
```
public static final String KEEP_ALIVE
```
    Event string for reading the select state.
    
    See Also:
    
    Constant Field Values
  - SET_SELECTED
```
public static final String SET_SELECTED
```
    Event string for setting the select state.
    
    See Also:
    
    Constant Field Values
  - EMPTY_ATTRIBUTE_NAME
```
public static final String EMPTY_ATTRIBUTE_NAME
```
    use this string to mark attribute names as being deliberately empty
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AttributeChip
```
public AttributeChip(DisplayState displayState,
                     Chip parent,
                     String attributeName,
                     Type valueType,
                     String editorType,
                     Class editorClass,
                     Object initialValue)
```
    Constructor for creating a new attribute chip for input of inheritable values. The editor is automaticaly set using the specified editor type. The following default values will be set: isEditable() = true getDescription() = ''
    Parameters:
    
    displayState - The current displaystate this chip belongs to.
    
    parent - The parent chip.
    
    attributeName - The name of the attribute. For output this will be used as key for a localized string.
    
    valueType - The type of the attribute, needed to initialize generic editors.
    
    editorType - The type identifier of the value-editor.
    
    editorClass - The class of the value-editor, which should be used.
    
    initialValue - The initial value of the editor.
    
    Throws:
    
    NullPointerException - If one of the parameters displayState, parent, attributeName, attributeType or inheritanceState is NULL.
  - AttributeChip
```
public AttributeChip(DisplayState displayState,
                     Chip parent,
                     String attributeName,
                     Type valueType,
                     String editorType,
                     Class editorClass)
```
  - AttributeChip
```
public AttributeChip(DisplayState displayState,
                     Chip parent,
                     String attributeName,
                     Type valueType)
```
    Constructor for creating a new attribute chip for input of inheritable values. Initially it does not contain an editor. It has to be set via method setEditor(AbstractAttributeEditorChip). The following default values will be set: isEditable() = true getDescription() = ''
    Parameters:
    
    displayState - The current displaystate this chip belongs to.
    
    parent - The parent chip.
    
    attributeName - The name of the attribute. For output this will be used as key for a localized string.
    
    Throws:
    
    NullPointerException - If one of the parameters displayState, parent, attributeName, attributeType or inheritanceState is NULL.
- Method Detail
  - isEncrypted
```
public boolean isEncrypted()
```
  - setEncrypted
```
public void setEncrypted(boolean encrypted)
```
  - setEditor
```
public void setEditor(AbstractAttributeEditorChip editor)
```
    Sets the editor which manages the input of the attribute value.
  - getEditor
```
public AbstractAttributeEditorChip getEditor()
```
    Returns:
    
    The editor used to handle the input of the value.
    
    Throws:
    
    RuntimeException - If the editor is not set.
  - createEditor
```
protected final AbstractAttributeEditorChip createEditor()
```
  - initializeEditor
```
protected void initializeEditor()
```
  - createEditor
```
public static final AbstractAttributeEditorChip createEditor(DisplayState displayState,
                                                             Chip parent,
                                                             Type attributeType)
```
  - createEditor
```
public static final AbstractAttributeEditorChip createEditor(DisplayState displayState,
                                                             Chip parent,
                                                             Type attributeType,
                                                             String editorType,
                                                             Class customEditorClass,
                                                             boolean isPartOf)
```
  - getValue
```
public Object getValue()
```
    Returns:
    
    The value of the AbstractAttributeEditorChip.
  - getInitialValue
```
public Object getInitialValue()
```
    Returns:
    
    The inital value of the AbstractAttributeEditorChip.
  - setValue
```
public void setValue(Object value)
```
  - isChanged
```
public boolean isChanged()
```
    Returns true if the value of this chip's editor has changed, i.e. if the editor's AbstractAttributeEditorChip.isChanged() method returns true.
    
    Returns:
    
    true if the value of this chip's editor has changed, i.e. if the editor's AbstractAttributeEditorChip.isChanged() method returns true.
    
    Since:
    
    2.00
  - isSelected
```
public boolean isSelected()
```
    Returns:
    
    Indicates if the attribute chip has been selected by activating the select box.
  - setSelected
```
public void setSelected(boolean staySelected)
```
    Sets the selection state.
  - setEditable
```
public void setEditable(boolean editable)
```
  - isEditable
```
public boolean isEditable()
```
    Returns:
    
    If the value of this input chip is writeable. Default value is TRUE.
  - setDescription
```
public void setDescription(String description)
```
    Sets a description as hint for inputing a value like 'Enter a string'.
    
    Parameters:
    
    description - The key for a localized string resource acting as hint. NULL is a legal value and means that no description will be shown.
  - getDescription
```
public String getDescription()
```
  - getLabel
```
public String getLabel()
```
    Returns:
    
    Localized name of the attribute as specified in a ResourceBundle.
  - getAttributeQualifier
```
public String getAttributeQualifier()
```
    Returns:
    
    Name of the attribute.
  - getAttributeDescriptor
```
public AttributeDescriptor getAttributeDescriptor()
```
    Gets the AttributeDescriptor Note: This is a hack. It retrieves the descriptor using the qualifier.
  - isRequired
```
public boolean isRequired()
```
  - isOptional
```
public boolean isOptional()
```
    Returns:
    
    True, if the edited attributedescriptor is optional.
  - isPartOf
```
public boolean isPartOf()
```
    Returns:
    
    True, if the edited attributedescriptor is partof.
  - processEvents
```
public void processEvents(Map<String,List<String>> 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
  - compareTo
```
public int compareTo(Object obj)
```
    Compares AttributeChips by comparing their labels.
    
    Specified by:
    
    compareTo in interface Comparable
  - 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
  - checkValid
```
public void checkValid()
```
    Description copied from class: AbstractChip
    
    Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()
    
    Specified by:
    
    checkValid in interface Chip
    
    Overrides:
    
    checkValid in class AbstractChip
  - getDefaultEditorType
```
public static String getDefaultEditorType(Type type,
                                          JaloSession jaloSession)
```
  - getDefaultEditorType
```
public static String getDefaultEditorType(Type type,
                                          JaloSession jaloSession,
                                          AttributeDescriptor descriptor)
```
    Returns:
    
    Default typecode for editor of given type.
  - getToolTip
```
public String getToolTip()
```
  - getProposedUniqueName
```
protected String getProposedUniqueName()
```
    Overrides:
    
    getProposedUniqueName in class AbstractChip
  - setError
```
public void setError(Exception exception)
```
  - hasErrorText
```
public boolean hasErrorText()
```
  - getErrorText
```
public String getErrorText()
```
  - setErrorText
```
public void setErrorText(String txt)
```
  - clearError
```
public void clearError()
```
  - getError
```
public Exception getError()
```
  - hasError
```
public boolean hasError()
```
  - setInitialValue
```
public void setInitialValue(Object initialValue)
```
  - getEditorClass
```
public Class getEditorClass()
```
    Returns:
    
    Returns the editorClass.
  - setEditorClass
```
public void setEditorClass(Class editorClass)
```
    Parameters:
    
    editorClass - The editorClass to set.
  - setEditorType
```
public void setEditorType(String editorType)
```
    Parameters:
    
    editorType - The editorType to set.
  - getAttributeType
```
public Type getAttributeType()
```
    Returns:
    
    Returns the attributeType.
  - getEditorType
```
public String getEditorType()
```
    Returns:
    
    editortype
  - getDescriptionAttributeValue
```
public String getDescriptionAttributeValue()
```
    If an additional attribute was given (via xml configuration), this method returns the string representation of the attribute (if it is found in the enclosing item).
    
    Returns:
    
    a String containing the additional description attribute value
  - setDescriptionAttribute
```
public void setDescriptionAttribute(String attributeName)
```
  - getDescriptionAttribute
```
public String getDescriptionAttribute()
```
  - setLabelWidth
```
public void setLabelWidth(int labelWidth)
```
  - setMaxLength
```
public void setMaxLength(int maxLength)
```
  - getLabelWidth
```
public int getLabelWidth()
```
  - isHideLabel
```
public boolean isHideLabel()
```
  - setHideLabel
```
public void setHideLabel(boolean hideLabel)
```
  - getItem
```
protected Item getItem()
```
    Returns the item of the enclosing ItemChip (if there is one).
    
    Since:
    
    3.00 (beta1)
  - saveAttribute
```
public void saveAttribute(AbstractAttributeEditorChip editorChip)
```
    Since:
    
    3.0 M2

Class AttributeChip

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

Field Detail

KEEP_ALIVE

SET_SELECTED

EMPTY_ATTRIBUTE_NAME

Constructor Detail

AttributeChip

AttributeChip

AttributeChip

Method Detail

isEncrypted

setEncrypted

setEditor

getEditor

createEditor

initializeEditor

createEditor

createEditor

getValue

getInitialValue

setValue

isChanged

isSelected

setSelected

setEditable

isEditable

setDescription

getDescription

getLabel

getAttributeQualifier

getAttributeDescriptor

isRequired

isOptional

isPartOf

processEvents

compareTo

getJSPURI

checkValid

getDefaultEditorType

getDefaultEditorType

getToolTip

getProposedUniqueName

setError

hasErrorText

getErrorText

setErrorText

clearError

getError

hasError

setInitialValue

getEditorClass

setEditorClass

setEditorType

getAttributeType

getEditorType

getDescriptionAttributeValue

setDescriptionAttribute

getDescriptionAttribute

setLabelWidth

setMaxLength

getLabelWidth

isHideLabel

setHideLabel

getItem

saveAttribute