|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.UserLayoutNodeDescription
org.jasig.portal.layout.UserLayoutFolderDescription
A class describing a folder node fo the user layout structure.
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 |
Constructor Summary | |
UserLayoutFolderDescription()
|
|
UserLayoutFolderDescription(org.w3c.dom.Element xmlNode)
Reconstruct folder information from an xml Element |
|
UserLayoutFolderDescription(IUserLayoutFolderDescription d)
|
Method Summary | |
void |
addNodeAttributes(org.w3c.dom.Element node)
Add all of common node attributes to the Element . |
int |
getFolderType()
Returns folder type. |
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. |
void |
setFolderType(int folderType)
Assign a type to a folder. |
Methods inherited from class org.jasig.portal.layout.UserLayoutNodeDescription |
createUserLayoutNodeDescription, getId, getName, isHidden, isImmutable, isUnremovable, setHidden, setId, setImmutable, setName, setUnremovable |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jasig.portal.layout.IUserLayoutNodeDescription |
getId, getName, isHidden, isImmutable, isUnremovable, setHidden, setId, setImmutable, setName, setUnremovable |
Field Detail |
public static final int REGULAR_TYPE
public static final int HEADER_TYPE
public static final int FOOTER_TYPE
public static final java.lang.String[] folderTypeNames
Constructor Detail |
public UserLayoutFolderDescription(org.w3c.dom.Element xmlNode) throws PortalException
Element
xmlNode
- a user layout channel Element
value
PortalException
- if xml is malformedpublic UserLayoutFolderDescription()
public UserLayoutFolderDescription(IUserLayoutFolderDescription d)
Method Detail |
public int getType()
getType
in interface IUserLayoutNodeDescription
getType
in class UserLayoutNodeDescription
public int getFolderType()
getFolderType
in interface IUserLayoutFolderDescription
int
value corresponding
to one of the valid folder types.public void setFolderType(int folderType)
setFolderType
in interface IUserLayoutFolderDescription
folderType
- an int
value corresponding
to one of the valid folder types.public org.w3c.dom.Element getXML(org.w3c.dom.Document root)
org.w3c.dom.Element
representation of the current node.
getXML
in interface IUserLayoutFolderDescription
getXML
in class UserLayoutNodeDescription
root
- a Document
for which the Element
should be created.
Node
valuepublic void addNodeAttributes(org.w3c.dom.Element node)
UserLayoutNodeDescription
Element
.
addNodeAttributes
in interface IUserLayoutNodeDescription
addNodeAttributes
in class UserLayoutNodeDescription
node
- an Element
value
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |