de.hybris.platform.hmc.generic.nodes

Class ReferenceCollectionEditorNode

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.ReferenceEditorNode

de.hybris.platform.hmc.generic.nodes.ReferenceCollectionEditorNode

All Implemented Interfaces:

Serializable, Cloneable

public class ReferenceCollectionEditorNode
extends ReferenceEditorNode

Node representing a GenericReferenceListEditorChip in the XML structure.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReferenceCollectionEditorNode(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	canAdd()
boolean	canCreate()
boolean	canRemove()
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()
ItemEditorLayoutNode	getItemEditorLayoutNode()
ItemDisplayLayoutNode	getItemLayoutNode()
int	getMaxCount()
String	getPresetAttributeName()
String	getTypeAttribute() Returns the 'typeattribute' name if it has been configured.
boolean	isAutoSave() Returns true if the 'autosave' attribute is set to true, false otherwise.
protected boolean	isConsiderSubtypes() If true (default), you will see a subtype select window when creating a new item in the list (if there are any subtypes).
boolean	isEditable()
protected boolean	isExternalCreate() If true (default), clicking the 'create' button will result in a new editor window for the new item.
boolean	isProhibitOpening()
boolean	isResortable()
boolean	isShowSearchEditor()

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

enhanceConditionChip, getCreationPresets, getNoSelectionName, getPresetSearchType, getSearchPresets, hasSearchAttribute, isAutoPerform

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

log

protected static final Logger log

Since:

2.20

Constructor Detail

ReferenceCollectionEditorNode

protected ReferenceCollectionEditorNode(Node parent,
                                        Map attributes)
                                 throws NodeCreationFailedException

Throws:

NodeCreationFailedException

Method Detail

isResortable

public boolean isResortable()

Returns:

true if the 'resortable' attribute exists and is set to "true" or "1", false otherwise

isProhibitOpening

public boolean isProhibitOpening()

Since:

3.1-u5

canAdd

public boolean canAdd()

canRemove

public boolean canRemove()

canCreate

public boolean canCreate()

Returns:

true if the 'create' attribute exists and is set to "true" or "1", false otherwise

isExternalCreate

protected boolean isExternalCreate()

If true (default), clicking the 'create' button will result in a new editor window for the new item. This will only take effect if 'editable' is also set to true.

Since:

2.20

isConsiderSubtypes

protected boolean isConsiderSubtypes()

If true (default), you will see a subtype select window when creating a new item in the list (if there are any subtypes).

Since:

2.20

getPresetAttributeName

public String getPresetAttributeName()

Returns:

the content of the 'presetattribute' attribute.

getMaxCount

public int getMaxCount()

Returns:

the number found in the 'maxcount' attribute

getItemLayoutNode

public ItemDisplayLayoutNode getItemLayoutNode()

Returns:

the ItemDisplayLayoutNode which is a child of this node, null if there is no such child!

getItemEditorLayoutNode

public ItemEditorLayoutNode getItemEditorLayoutNode()

Returns:

the ItemEditorLayoutNode which is a child of this node, null if there is no such child!

Since:

2.20

isAutoSave

public boolean isAutoSave()

Returns true if the 'autosave' attribute is set to true, false otherwise.

Returns:

true if the 'autosave' attribute is set to true, false otherwise.

isEditable

public boolean isEditable()

Returns:

true if the 'editable' attribute exists and is set to "true" or "1", false otherwise

Since:

2.20

getTypeAttribute

public String getTypeAttribute()

Returns the 'typeattribute' name if it has been configured. The attribute will be used to get the type of the elements of the reference collection.

Returns:

'typeattribute' name if it has been configured.

Since:

2.20

isShowSearchEditor

public boolean isShowSearchEditor()

Returns:

true if the 'showsearcheditor' attribute exists and is set to "true" or "1", false otherwise

Since:

3.0M2

getEditorType

public String getEditorType()

Overrides:

getEditorType in class ReferenceEditorNode

Returns:

the editor type for this node based on the resortable flag (either GenericResortableReferenceListEditorChip or GenericReferenceListEditorChip)

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 ReferenceEditorNode

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.

Overrides:

clone in class ReferenceEditorNode

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 ReferenceEditorNode

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