uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Interface IUserLayoutNodeDescription

All Known Subinterfaces:
IALChannelDescription, IALFolderDescription, IALNodeDescription, IUserLayoutChannelDescription, IUserLayoutFolderDescription
All Known Implementing Classes:
ALChannelDescription, ALFolderDescription, UserLayoutChannelDescription, UserLayoutFolderDescription, UserLayoutNodeDescription

public interface IUserLayoutNodeDescription

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

Version:
1.0
Author:
Peter Kharchenko

Field Summary
static int CHANNEL
          Constants indicating the type of a node
static int FOLDER
           
 
Method Summary
 void addNodeAttributes(org.w3c.dom.Element node)
           
 java.lang.String getId()
          Returns a node Id.
 java.lang.String getName()
          Determine a name associated with this node.
 int getType()
          Returns a type of the node, could be FOLDER or CHANNEL integer constant.
 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)
           
 

Field Detail

CHANNEL

public static final int CHANNEL
Constants indicating the type of a node

See Also:
Constant Field Values

FOLDER

public static final int FOLDER
See Also:
Constant Field Values
Method Detail

getId

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

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.


getName

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

Returns:
a folder/channel name.

getType

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

Returns:
a type

setName

public void setName(java.lang.String name)

isUnremovable

public boolean isUnremovable()

setUnremovable

public void setUnremovable(boolean setting)

isImmutable

public boolean isImmutable()

setImmutable

public void setImmutable(boolean setting)

isHidden

public boolean isHidden()

setHidden

public void setHidden(boolean setting)

getXML

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

Parameters:
root - a Document for which the Element should be created.
Returns:
a Element value

addNodeAttributes

public void addNodeAttributes(org.w3c.dom.Element node)

uPortal 2.4.1
API Documentation