de.hybris.platform.hmc.generic.nodes

Class TypeNode

java.lang.Object

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

de.hybris.platform.hmc.generic.nodes.TypeNode

All Implemented Interfaces:

Serializable, Cloneable

public class TypeNode
extends Node

Representation for the XML-tag type of the layout configuration file.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ICON

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addAttribute(ComposedType type, List<String> attributes, Node node)
protected void	checkCreateConditions(Node parent, Map attributes) Check if type is found.
Node	clone(Node newParent) This method returns a clone of the current node whichs parent node is specified by the parameter newParent.
Node	cloneAll(Node newParent) This method returns a clone subtree beginning with the current node whichs parent node is specified by the parameter newParent, including all children as clones except the LabelCollectionNodes, which must not be cloned.
DefaultReferenceNode	getDefaultReferenceNode()
int	getDefaultSearchResultViewMode()
List<String>	getDisplayedAttributes(ComposedType type)
EditorNode	getEditorNode() Returns the EditorNode which is a child of the organizernode of this typenode.
List	getExcludedAttributes()
ExplorerNode	getExplorer()
String	getIcon()
String	getName()
OrganizerNode	getOrganizer() Returns the OrganizerNode which is a child of this typenode.
String	getReferenceSearchAttributeName()
ResultNode	getResult() Returns the ResultNode which is a child of this TypeNode.
SearchNode	getSearchNode()
ItemLayoutNode	getSearchResultItemLayoutNode(int viewMode) Returns the ItemLayoutDescriptor which is to be used to display (default) search results of the type this node represents.
ExplorableNode	getTreeViewExplorableNode()
ComposedType	getType()
ComposedType	getType(JaloSession jaloSession) Deprecated. please use method getType()
boolean	isToolbarCreate()
void	removeReferenceFinderAttribute()
void	setIcon(String icon)
void	setName(String name)
void	setUseSelector(String useSelector)
boolean	showScrollbar(int viewMode)
boolean	useSelector()

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

addAttribute, addChild, addChildren, getAttributes, getBooleanAttribute, getBooleanAttribute, getCachedObject, getChild, getChildren, getChildren, getChildrenInternal, 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_ICON

public static final String DEFAULT_ICON

See Also:

Constant Field Values

Constructor Detail

TypeNode

protected TypeNode(Node parent,
                   Map attributes)
            throws NodeCreationFailedException

Throws:

NodeCreationFailedException

Method Detail

checkCreateConditions

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

Check if type is found.

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

getName

public String getName()

getIcon

public String getIcon()

useSelector

public boolean useSelector()

getSearchResultItemLayoutNode

public ItemLayoutNode getSearchResultItemLayoutNode(int viewMode)

Returns the ItemLayoutDescriptor which is to be used to display (default) search results of the type this node represents.

Parameters:

viewMode - the view mode (see Constants.LISTMODES)

Returns:

the itemlayoutdescriptor for search results

showScrollbar

public boolean showScrollbar(int viewMode)

getDefaultSearchResultViewMode

public int getDefaultSearchResultViewMode()

getTreeViewExplorableNode

public ExplorableNode getTreeViewExplorableNode()

getResult

public ResultNode getResult()

Returns the ResultNode which is a child of this TypeNode.

Returns:

resultnode

getDefaultReferenceNode

public DefaultReferenceNode getDefaultReferenceNode()

getSearchNode

public SearchNode getSearchNode()

getExplorer

public ExplorerNode getExplorer()

getEditorNode

public EditorNode getEditorNode()

Returns the EditorNode which is a child of the organizernode of this typenode.

Overrides:

getEditorNode in class Node

Returns:

editornode of this node

getOrganizer

public OrganizerNode getOrganizer()

Returns the OrganizerNode which is a child of this typenode.

Returns:

organizernode of this node

getReferenceSearchAttributeName

public String getReferenceSearchAttributeName()

removeReferenceFinderAttribute

public void removeReferenceFinderAttribute()

Since:

2.20

getType

@Deprecated
public ComposedType getType(JaloSession jaloSession)

Deprecated. please use method getType()

getType

public ComposedType getType()

isToolbarCreate

public boolean isToolbarCreate()

getDisplayedAttributes

public List<String> getDisplayedAttributes(ComposedType type)

getExcludedAttributes

public List getExcludedAttributes()

addAttribute

protected void addAttribute(ComposedType type,
                            List<String> attributes,
                            Node node)

setName

public void setName(String name)

setIcon

public void setIcon(String icon)

setUseSelector

public void setUseSelector(String useSelector)

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.

cloneAll

public Node cloneAll(Node newParent)

This method returns a clone subtree beginning with the current node whichs parent node is specified by the parameter newParent, including all children as clones except the LabelCollectionNodes, which must not be cloned.

Overrides:

cloneAll in class Node

Parameters:

newParent - The parent of the cloned node.

Returns:

Cloned node instance referring to the new parent, including all children.