de.hybris.platform.hmc.generic.nodes

Class AttributeChipNode

java.lang.Object

de.hybris.platform.hmc.generic.nodes.Node

de.hybris.platform.hmc.generic.nodes.TypeChildNode

de.hybris.platform.hmc.generic.nodes.AttributeChipNode

All Implemented Interfaces:

ChipCreator, Serializable, Cloneable

Direct Known Subclasses:

CustomAttributeChipNode

public class AttributeChipNode
extends TypeChildNode
implements ChipCreator

Abstract class for all nodes representing an attribute editor.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttributeChipNode(Node parent, Map<String,String> attributes)

Method Summary

Modifier and Type	Method and Description
protected void	checkCreateConditions(Node parent, Map attributes) This method will automatically be called during creation of this Node.
Node	clone(Node newParent) This method returns a clone of the current node whichs parent node is specified by the parameter newParent.
AttributeChip	createAttributeChip(DisplayState displayState, Chip parent, String editorTypeCode, Class customEditorClass)
Chip	createChip(DisplayState displayState, Chip parent)
String	getAttributeName()
protected String	getDescriptionAttributeName()
protected boolean	getEditable()
boolean	getHideLabel()
int	getLabelWidth()
int	getMaxLength()
Type	getType(JaloSession jaloSession)
int	getWidth()
String	toString()

Methods inherited from class de.hybris.platform.hmc.generic.nodes.TypeChildNode

findTypeNode, getAttributeDescriptor

Methods inherited from class de.hybris.platform.hmc.generic.nodes.Node

addAttribute, addChild, addChildren, cloneAll, getAttributes, getBooleanAttribute, getBooleanAttribute, getCachedObject, getChild, getChildren, getChildren, getChildrenInternal, getEditorNode, getElementName, getIntegerAttribute, getIntegerAttribute, getLogger, getParent, getPosition, getPositionInfo, getStringAttribute, getStringAttribute, getSuperNode, removeAttribute, removeChild, replace, replaceChild, setAttributes, setElementName, setParent, setPosition, setPositionInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeChipNode

protected AttributeChipNode(Node parent,
                            Map<String,String> attributes)
                     throws NodeCreationFailedException

Throws:

NodeCreationFailedException

Method Detail

toString

public String toString()

Overrides:

toString in class Object

createAttributeChip

public AttributeChip createAttributeChip(DisplayState displayState,
                                         Chip parent,
                                         String editorTypeCode,
                                         Class customEditorClass)

Returns:

The attribute chip with the custom editor type specified by the -tag for editing the attribute.

createChip

public Chip createChip(DisplayState displayState,
                       Chip parent)

Specified by:

createChip in interface ChipCreator

getAttributeName

public String getAttributeName()

Returns:

The name of the attribute bound to this editor node.

getWidth

public int getWidth()

Returns:

the width of the attribute or 0 if the width is not set

getLabelWidth

public int getLabelWidth()

Returns:

the width of the attribute label or the if the width is not set

getMaxLength

public int getMaxLength()

Returns:

the width of the attribute label or the if the width is not set

getHideLabel

public boolean getHideLabel()

getEditable

protected boolean getEditable()

Returns:

whether the editor should be editable or not. Should only be evaluated if it returns 'false'.

getType

public Type getType(JaloSession jaloSession)
             throws JaloItemNotFoundException

Returns:

The type of the attribute bounded to this editor node.

Throws:

JaloItemNotFoundException

checkCreateConditions

protected void checkCreateConditions(Node parent,
                                     Map attributes)
                              throws NodeCreationFailedException

Description copied from class: Node

This method will automatically be called during creation of this Node. Override it to check for special conditions which have to be fulfilled to successfully create your Node implementation. Throw a NodeCreationFailedException if the creation fails. Note: At the time this method is called, getParent() and getXYZAttribute() will not work! Be sure to use the given parameters instead!

Overrides:

checkCreateConditions in class Node

Parameters:

parent - the parent node as given to the constructor

attributes - the attribute map as given to the constructor

Throws:

NodeCreationFailedException - if the creation of the node fails

clone

public Node clone(Node newParent)

Description copied from class: Node

This method returns a clone of the current node whichs parent node is specified by the parameter newParent.

Specified by:

clone in class Node

Parameters:

newParent - The parent of the cloned node.

Returns:

Cloned node instance refering to the new parent.

getDescriptionAttributeName

protected String getDescriptionAttributeName()