uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Class UserLayoutNodeDescription

java.lang.Object
  extended byorg.jasig.portal.layout.UserLayoutNodeDescription
All Implemented Interfaces:
IUserLayoutNodeDescription
Direct Known Subclasses:
UserLayoutChannelDescription, UserLayoutFolderDescription

public abstract class UserLayoutNodeDescription
extends java.lang.Object
implements IUserLayoutNodeDescription

An class describing common features of user layout nodes, that is channels and folders

Version:
1.0
Author:
Peter Kharchenko

Field Summary
 
Fields inherited from interface org.jasig.portal.layout.IUserLayoutNodeDescription
CHANNEL, FOLDER
 
Constructor Summary
UserLayoutNodeDescription()
           
UserLayoutNodeDescription(IUserLayoutNodeDescription d)
           
 
Method Summary
 void addNodeAttributes(org.w3c.dom.Element node)
          Add all of common node attributes to the Element.
static UserLayoutNodeDescription createUserLayoutNodeDescription(org.w3c.dom.Element xmlNode)
          A factory method to create a UserLayoutNodeDescription instance, based on the information provided in the user layout Element.
 java.lang.String getId()
          Returns a node Id.
 java.lang.String getName()
          Determine a name associated with this node.
abstract  int getType()
          Returns a type of the node, could be FOLDER or CHANNEL integer constant.
abstract  org.w3c.dom.Element getXML(org.w3c.dom.Document root)
          Creates a org.w3c.dom.Element representation of the current node.
 boolean isHidden()
           
 boolean isImmutable()
           
 boolean isUnremovable()
           
 void setHidden(boolean setting)
           
 void setId(java.lang.String id)
          Set a new node Id.
 void setImmutable(boolean setting)
           
 void setName(java.lang.String name)
           
 void setUnremovable(boolean setting)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserLayoutNodeDescription

public UserLayoutNodeDescription()

UserLayoutNodeDescription

public UserLayoutNodeDescription(IUserLayoutNodeDescription d)
Method Detail

getId

public java.lang.String getId()
Returns a node Id. The Id has to be unique in the entire user layout document.

Specified by:
getId in interface IUserLayoutNodeDescription
Returns:
a String value

setId

public void setId(java.lang.String id)
Set a new node Id. The Id has to be unique in the entire user layout document.

Specified by:
setId in interface IUserLayoutNodeDescription

getName

public java.lang.String getName()
Determine a name associated with this node.

Specified by:
getName in interface IUserLayoutNodeDescription
Returns:
a folder/channel name.

setName

public void setName(java.lang.String name)
Specified by:
setName in interface IUserLayoutNodeDescription

isUnremovable

public boolean isUnremovable()
Specified by:
isUnremovable in interface IUserLayoutNodeDescription

setUnremovable

public void setUnremovable(boolean setting)
Specified by:
setUnremovable in interface IUserLayoutNodeDescription

isImmutable

public boolean isImmutable()
Specified by:
isImmutable in interface IUserLayoutNodeDescription

setImmutable

public void setImmutable(boolean setting)
Specified by:
setImmutable in interface IUserLayoutNodeDescription

isHidden

public boolean isHidden()
Specified by:
isHidden in interface IUserLayoutNodeDescription

setHidden

public void setHidden(boolean setting)
Specified by:
setHidden in interface IUserLayoutNodeDescription

getType

public abstract int getType()
Returns a type of the node, could be FOLDER or CHANNEL integer constant.

Specified by:
getType in interface IUserLayoutNodeDescription
Returns:
a type

getXML

public abstract org.w3c.dom.Element getXML(org.w3c.dom.Document root)
Creates a org.w3c.dom.Element representation of the current node.

Specified by:
getXML in interface IUserLayoutNodeDescription
Parameters:
root - a Document for which the Element should be created.
Returns:
a Element value

addNodeAttributes

public void addNodeAttributes(org.w3c.dom.Element node)
Add all of common node attributes to the Element.

Specified by:
addNodeAttributes in interface IUserLayoutNodeDescription
Parameters:
node - an Element value

createUserLayoutNodeDescription

public static UserLayoutNodeDescription createUserLayoutNodeDescription(org.w3c.dom.Element xmlNode)
                                                                 throws PortalException
A factory method to create a UserLayoutNodeDescription instance, based on the information provided in the user layout Element.

Parameters:
xmlNode - a user layout DTD folder/channel Element value
Returns:
an UserLayoutNodeDescription value
Throws:
PortalException - if the xml passed is somehow invalid.

uPortal 2.4.1
API Documentation