de.hybris.platform.hmc.generic.nodes

Class CollectionEditorNode

java.lang.Object

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

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

de.hybris.platform.hmc.generic.nodes.AbstractEditorNode

de.hybris.platform.hmc.generic.nodes.CollectionEditorNode

All Implemented Interfaces:

Serializable, Cloneable

public class CollectionEditorNode
extends AbstractEditorNode

Node representing a GenericReferenceListEditorChip in the XML structure.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TITLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionEditorNode(Node parent, Map attributes)

Method Summary

Modifier and Type	Method and Description
void	adjustEditorSettings(AbstractAttributeEditorChip editor) Adjusts the settings of the editor chip according to the configuration specified in the xml file.
boolean	canAddAndRemove()
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.
String	getEditorType()
ClassConfigNode	getElementEditorNode() Returns the ClassConfigNode which is a child of this node (element "editor") and which contains the description of the attribute editor chip which is to be used as editor for the elements of the collection.
String	getTitle()
boolean	isEditable()
boolean	isResortable()

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

getAttributeName, getParameters, getType, getType

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

Field Detail

DEFAULT_TITLE

public static final String DEFAULT_TITLE

Since:

2.20 (has been private before)

See Also:

Constant Field Values

Constructor Detail

CollectionEditorNode

protected CollectionEditorNode(Node parent,
                               Map attributes)
                        throws NodeCreationFailedException

Throws:

NodeCreationFailedException

Method Detail

isResortable

public boolean isResortable()

isEditable

public boolean isEditable()

Since:

2.20

canAddAndRemove

public boolean canAddAndRemove()

getTitle

public String getTitle()

Since:

2.10

getEditorType

public String getEditorType()

Specified by:

getEditorType in class AbstractEditorNode

Returns:

The editortype code, which should be used to edit this attribute.

getElementEditorNode

public ClassConfigNode getElementEditorNode()

Returns the ClassConfigNode which is a child of this node (element "editor") and which contains the description of the attribute editor chip which is to be used as editor for the elements of the collection.

Since:

2.20

adjustEditorSettings

public void adjustEditorSettings(AbstractAttributeEditorChip editor)

Description copied from class: AbstractEditorNode

Adjusts the settings of the editor chip according to the configuration specified in the xml file. Be sure to always call super.adjustEditorSettings() from within your own implementation unless you know exactly what you are doing!

Overrides:

adjustEditorSettings in class AbstractEditorNode

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.

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