|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.alm.ALNode
public abstract class ALNode
IALNode summary sentence goes here.
Company: Instructional Media & Magic Prior to uPortal 2.5, this class existed in the package org.jasig.portal.layout. It was moved to its present package to reflect that it is part of Aggregated Layouts.
Field Summary | |
---|---|
private java.lang.String |
nextNodeId
|
private IALNodeDescription |
nodeDescription
|
private java.lang.String |
parentNodeId
|
private java.lang.String |
previousNodeId
|
private int |
priority
|
Constructor Summary | |
---|---|
ALNode()
|
|
ALNode(IALNodeDescription nd)
|
Method Summary | |
---|---|
protected void |
addNodeAttributes(org.w3c.dom.Element node)
Add all of common node attributes to the Element . |
static ALNode |
createALNode(IUserLayoutNodeDescription nodeDescription)
|
static IALNodeDescription |
createUserLayoutNodeDescription(org.w3c.dom.Element xmlNode)
A factory method to create a IALNodeDescription instance,
based on the information provided in the user layout Element . |
java.lang.String |
getFragmentId()
|
java.lang.String |
getFragmentNodeId()
|
java.lang.String |
getId()
|
java.lang.String |
getNextNodeId()
|
IUserLayoutNodeDescription |
getNodeDescription()
|
abstract int |
getNodeType()
Gets the node type |
java.lang.String |
getParentNodeId()
|
java.lang.String |
getPreviousNodeId()
|
int |
getPriority()
Gets the priority value for this node. |
IUserLayoutRestriction |
getRestriction(java.lang.String restrictionName)
Gets a restriction by the type. |
java.util.Collection |
getRestrictionsByPath(java.lang.String restrictionPath)
Gets a restrictions list by a restriction path. |
void |
setNextNodeId(java.lang.String nextNodeId)
|
void |
setNodeDescription(IALNodeDescription nd)
|
void |
setParentNodeId(java.lang.String parentNodeId)
|
void |
setPreviousNodeId(java.lang.String previousNodeId)
|
void |
setPriority(int priority)
Sets the priority for this node. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private java.lang.String parentNodeId
private java.lang.String nextNodeId
private java.lang.String previousNodeId
private IALNodeDescription nodeDescription
private int priority
Constructor Detail |
---|
public ALNode()
public ALNode(IALNodeDescription nd)
Method Detail |
---|
public java.lang.String getId()
getId
in interface ILayoutNode
public java.lang.String getFragmentId()
getFragmentId
in interface IALNode
public java.lang.String getFragmentNodeId()
getFragmentNodeId
in interface IALNode
public abstract int getNodeType()
getNodeType
in interface ILayoutNode
public void setNodeDescription(IALNodeDescription nd)
public IUserLayoutNodeDescription getNodeDescription()
getNodeDescription
in interface ILayoutNode
public void setParentNodeId(java.lang.String parentNodeId)
public java.lang.String getParentNodeId()
getParentNodeId
in interface ILayoutNode
public void setNextNodeId(java.lang.String nextNodeId)
public java.lang.String getNextNodeId()
getNextNodeId
in interface ILayoutNode
public void setPreviousNodeId(java.lang.String previousNodeId)
public java.lang.String getPreviousNodeId()
getPreviousNodeId
in interface ILayoutNode
public void setPriority(int priority)
priority
- a int
priority valuepublic int getPriority()
public IUserLayoutRestriction getRestriction(java.lang.String restrictionName)
restrictionName
- a String
name of the restriction
public java.util.Collection getRestrictionsByPath(java.lang.String restrictionPath)
restrictionPath
- a String
restriction path
protected void addNodeAttributes(org.w3c.dom.Element node)
Element
.
node
- an Element
valuepublic static IALNodeDescription createUserLayoutNodeDescription(org.w3c.dom.Element xmlNode) throws PortalException
IALNodeDescription
instance,
based on the information provided in the user layout Element
.
xmlNode
- a user layout DTD folder/channel Element
value
IALNodeDescription
value
PortalException
- if the xml passed is somehow invalid.public static ALNode createALNode(IUserLayoutNodeDescription nodeDescription) throws PortalException
PortalException
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |