uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Interface IUserLayoutFolderDescription

All Superinterfaces:
IUserLayoutNodeDescription
All Known Subinterfaces:
IALFolderDescription
All Known Implementing Classes:
ALFolderDescription, UserLayoutFolderDescription

public interface IUserLayoutFolderDescription
extends IUserLayoutNodeDescription

An interface describing a folder user layout node.

Version:
1.0
Author:
Peter Kharchenko

Field Summary
static java.lang.String[] folderTypeNames
           
static int FOOTER_TYPE
           
static int HEADER_TYPE
           
static int REGULAR_TYPE
           
 
Fields inherited from interface org.jasig.portal.layout.IUserLayoutNodeDescription
CHANNEL, FOLDER
 
Method Summary
 int getFolderType()
          Returns folder type.
 org.w3c.dom.Element getXML(org.w3c.dom.Document root)
          Creates a org.w3c.dom.Element representation of the current node.
 void setFolderType(int folderType)
          Assign a type to a folder.
 
Methods inherited from interface org.jasig.portal.layout.IUserLayoutNodeDescription
addNodeAttributes, getId, getName, getType, isHidden, isImmutable, isUnremovable, setHidden, setId, setImmutable, setName, setUnremovable
 

Field Detail

REGULAR_TYPE

public static final int REGULAR_TYPE
See Also:
Constant Field Values

HEADER_TYPE

public static final int HEADER_TYPE
See Also:
Constant Field Values

FOOTER_TYPE

public static final int FOOTER_TYPE
See Also:
Constant Field Values

folderTypeNames

public static final java.lang.String[] folderTypeNames
Method Detail

getFolderType

public int getFolderType()
Returns folder type.

Returns:
an int value corresponding to one of the valid folder types.

setFolderType

public void setFolderType(int folderType)
Assign a type to a folder.

Parameters:
folderType - an int value corresponding to one of the valid folder types.

getXML

public 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 Node value

uPortal 2.4.1
API Documentation