|
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
An class describing common features of user layout nodes, that is channels and folders
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 |
public UserLayoutNodeDescription()
public UserLayoutNodeDescription(IUserLayoutNodeDescription d)
Method Detail |
public java.lang.String getId()
getId
in interface IUserLayoutNodeDescription
String
valuepublic void setId(java.lang.String id)
setId
in interface IUserLayoutNodeDescription
public java.lang.String getName()
getName
in interface IUserLayoutNodeDescription
public void setName(java.lang.String name)
setName
in interface IUserLayoutNodeDescription
public boolean isUnremovable()
isUnremovable
in interface IUserLayoutNodeDescription
public void setUnremovable(boolean setting)
setUnremovable
in interface IUserLayoutNodeDescription
public boolean isImmutable()
isImmutable
in interface IUserLayoutNodeDescription
public void setImmutable(boolean setting)
setImmutable
in interface IUserLayoutNodeDescription
public boolean isHidden()
isHidden
in interface IUserLayoutNodeDescription
public void setHidden(boolean setting)
setHidden
in interface IUserLayoutNodeDescription
public abstract int getType()
getType
in interface IUserLayoutNodeDescription
public abstract org.w3c.dom.Element getXML(org.w3c.dom.Document root)
org.w3c.dom.Element
representation of the current node.
getXML
in interface IUserLayoutNodeDescription
root
- a Document
for which the Element
should be created.
Element
valuepublic void addNodeAttributes(org.w3c.dom.Element node)
Element
.
addNodeAttributes
in interface IUserLayoutNodeDescription
node
- an Element
valuepublic static UserLayoutNodeDescription createUserLayoutNodeDescription(org.w3c.dom.Element xmlNode) throws PortalException
UserLayoutNodeDescription
instance,
based on the information provided in the user layout Element
.
xmlNode
- a user layout DTD folder/channel Element
value
UserLayoutNodeDescription
value
PortalException
- if the xml passed is somehow invalid.
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |