public abstract class AbstractNode extends Object implements INode, IEventTarget
| Modifier and Type | Field and Description |
|---|---|
protected NodeMode |
m_mode |
protected String |
m_nodeName |
protected IPortalComponent |
m_portalComponent |
protected IPortalNode |
mm_portalNode |
ABOUT_MODE, ABOUT_REQUEST_EVENT, ACTION_EVENT, AFTER_CONTENT_EVENT, BEFORE_CONTENT_EVENT, COMPONENT_EVENT, COMPONENT_NODE, DEFAULT_MODE, EDIT_ACKNOWLEDGE_EVENT, EDIT_MODE, EDIT_REQUEST_EVENT, HELP_MODE, HELP_REQUEST_EVENT, LOGON_EVENT, LOGON_MODE, LOGOUT_EVENT, ON_NODE_READY_EVENT, ON_NODE_REMOVE_EVENT, ON_POM_READY_EVENT, PORTAL_NODE, PREVIEW_MODE, PREVIEW_REQUEST_EVENT, REFRESH_MODE, REFRESH_REQUEST_EVENT, REQUEST_EVENT, TEST_MODE| Modifier | Constructor and Description |
|---|---|
|
AbstractNode(String nodeName)
Builds a node without referencing a IPortalComponent
|
protected |
AbstractNode(String nodeName,
IPortalComponent aComponent)
Constructor
|
| Modifier and Type | Method and Description |
|---|---|
INode |
addChildNode(INode node)
Adds a node as a children of this node.
|
void |
addEventListener(EventType type,
IEventListener listener)
Registers an event listener for this node.
|
void |
addEventListener(EventType type,
IEventListener listener,
IEventFilter filter)
Registers an event listener for this node.
|
void |
dispatchEvent(IEvent evt)
Start dispatching of an event.
|
INodeList |
getChildNodes()
Returns the child nodes
|
INodeList |
getChildNodesByName(String name)
Finds direct children by a specified name.
|
IPortalComponent |
getComponent()
Gets the (@link IPortalComponent IPortalComponent} linked with this node.
|
INode |
getFirstChild()
Returns the first child
|
INode |
getLastChild()
Returns the
|
INode |
getNextSibling()
Returns the
|
INode |
getNextSiblingOfChild(INode childNode)
Returns the
|
String |
getNodeMark()
Retrieves the mark set on this node.
|
NodeMode |
getNodeMode()
Gets the mode to be used for the associated component during this request.
|
String |
getNodeName()
The name given during the node construction.
|
INode |
getParentNode()
Returns the
|
IPortalNode |
getPortalNode()
Returns the
|
INode |
getPreviousSibling()
Returns the
|
INode |
getPreviousSiblingOfChild(INode childNode)
Returns the
|
Object |
getValue(String name)
Retrieves an object from this node according to its name.
|
boolean |
hasChildNodes()
If this node has children
|
boolean |
isRootNode()
Whether this node is a root node or not.
|
void |
putValue(String name,
Object value)
Enables to register an object value associated with this node.
|
void |
release()
from interface IReleasable
|
void |
removeChildNode(INode node)
Removes the given node from the children of this node.
|
void |
removeEventListener(EventType type,
IEventListener listener)
Unregisters an event listener.
|
void |
removeEventListener(EventType type,
IEventListener listener,
IEventFilter filter)
Unregisters an event listener.
|
void |
removeValue(String name)
Removes an object from this node
|
void |
setNodeMark(String mark)
Sets a mark on this node.
|
void |
setNodeMode(NodeMode mode)
Sets the mode to be used for the associated component during this request.
|
void |
setParentNode(INode parentNode)
Sets the parent node of this node
|
void |
setPortalNode(IPortalNode portalNode)
Registers the
portal Node of this node |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetNodeTypeprotected String m_nodeName
protected IPortalNode mm_portalNode
protected IPortalComponent m_portalComponent
protected NodeMode m_mode
public AbstractNode(String nodeName)
nodeName - The name identifying the nodeprotected AbstractNode(String nodeName, IPortalComponent aComponent)
nodeName - The name of the nodepublic void setPortalNode(IPortalNode portalNode)
portal Node of this nodesetPortalNode in interface INodeportalNode - The portal node to setpublic String getNodeName()
getNodeName in interface INodepublic IPortalComponent getComponent()
getComponent in interface INodepublic void setNodeMode(NodeMode mode)
setNodeMode in interface INodemode - public NodeMode getNodeMode()
DEFAULT_MODE temporarily until the node
is part of the POM (addChildNode is called with this node)getNodeMode in interface INodepublic INodeList getChildNodes()
getChildNodes in interface INodepublic INode getFirstChild()
getFirstChild in interface INodepublic INode getLastChild()
getLastChild in interface INodepublic INode getNextSibling()
getNextSibling in interface INodepublic INode getPreviousSibling()
getPreviousSibling in interface INodepublic INode getPreviousSiblingOfChild(INode childNode)
getPreviousSiblingOfChild in interface INodechildNode - the reference node to obtain the siblingpublic INode getNextSiblingOfChild(INode childNode)
getNextSiblingOfChild in interface INodechildNode - the reference node to obtain the siblingpublic INode addChildNode(INode node) throws PortalOMException
addChildNode in interface INodenode - the node to add as a childPortalOMException - If the child node is null or it already
belong to another nodepublic void removeChildNode(INode node) throws PortalOMException
removeChildNode in interface INodenode - The node to removePortalOMExceptionpublic INode getParentNode()
getParentNode in interface INodepublic IPortalNode getPortalNode()
getPortalNode in interface INodepublic void setParentNode(INode parentNode)
setParentNode in interface INodeparentNode - public boolean hasChildNodes()
INodehasChildNodes in interface INodepublic boolean isRootNode()
IPortalNode are supposed to be root
nodes.true if this node is the root node.public INodeList getChildNodesByName(String name)
getChildNodesByName in interface INodename - The search namepublic void removeEventListener(EventType type, IEventListener listener)
removeEventListener in interface IEventTargettype - listener - public void removeEventListener(EventType type, IEventListener listener, IEventFilter filter)
type - listener - public void addEventListener(EventType type, IEventListener listener, IEventFilter filter) throws PortalOMException
addEventListener in interface IEventTargettype - the EventType, the Listener wants to listen tolistener - the listener to addfilter - the event filter or nullPortalOMExceptionpublic void addEventListener(EventType type, IEventListener listener) throws PortalOMException
addEventListener in interface IEventTargettype - the EventType, the Listener wants to listen tolistener - the listener to addPortalOMExceptionpublic void dispatchEvent(IEvent evt) throws PortalOMException
dispatchEvent in interface IEventTargetevt - the event to dispatchPortalOMExceptionpublic void putValue(String name, Object value)
public Object getValue(String name)
putValue methodpublic void removeValue(String name)
removeValue in interface INodename - An identifier of the objectpublic void setNodeMark(String mark)
IPortalComponentRequest.createComponentURL(com.sapportals.portal.prt.pom.INode, com.sapportals.portal.prt.event.IPortalRequestEvent).
In order to keep generated urls short you should use the mark up mechanisms
carefully.setNodeMark in interface INodemark - The mark to be put on this nodepublic String getNodeMark()
getNodeMark in interface INodepublic void release()
release in interface IReleasable| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] EP-BASIS-API
|
[sap.com]
|
default
|
EP-PIN-PRT
|
[sap.com] EP-BASIS-API
|
[sap.com] tc/epbc/prt/api
|
api
|
EP-PIN
|
[sap.com] EP-BASIS-API
|
[sap.com] tc/epbc/prt/lib/api
|
api
|
EP-PIN
|
[sap.com] EP-RUNTIME
|
[sap.com] tc/ep/semantics/api
|
api
|
EP-PIN
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2021 SAP SE Complete Copyright Notice