|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.node.UserLayoutNodeDescription
public abstract class UserLayoutNodeDescription
An class describing common features of user layout nodes, that is channels and folders
Field Summary | |
---|---|
protected boolean |
addChildAllowed
|
protected boolean |
deleteAllowed
|
protected boolean |
editAllowed
|
protected boolean |
hidden
|
protected java.lang.String |
id
|
protected boolean |
immutable
|
protected boolean |
moveAllowed
|
protected java.lang.String |
name
|
protected double |
precedence
|
protected boolean |
unremovable
|
Fields inherited from interface org.jasig.portal.layout.node.IUserLayoutNodeDescription |
---|
CHANNEL, FOLDER |
Constructor Summary | |
---|---|
UserLayoutNodeDescription()
|
|
UserLayoutNodeDescription(org.w3c.dom.Element xmlNode)
|
|
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. |
double |
getPrecedence()
Returns the precedence value for 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 |
isAddChildAllowed()
Returns true if a child node may be added to the node. |
boolean |
isDeleteAllowed()
Returns true if the node can be deleted. |
boolean |
isEditAllowed()
Returns true if the node can be edited. |
boolean |
isHidden()
|
boolean |
isImmutable()
|
boolean |
isMoveAllowed()
Returns true if the node can be moved. |
boolean |
isUnremovable()
|
void |
setAddChildAllowed(boolean setting)
Set whether or not child nodes can be added to this node. |
void |
setDeleteAllowed(boolean setting)
Set whether a node can be deleted or not. |
void |
setEditAllowed(boolean setting)
Set whether a node can be edited or not. |
void |
setHidden(boolean setting)
|
void |
setId(java.lang.String id)
Set a new node Id. |
void |
setImmutable(boolean setting)
|
void |
setMoveAllowed(boolean setting)
Set whether a node can be moved or not. |
void |
setName(java.lang.String name)
|
void |
setPrecedence(double setting)
Set the precedence of a node. |
void |
setUnremovable(boolean setting)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String id
protected java.lang.String name
protected boolean immutable
protected boolean unremovable
protected boolean hidden
protected boolean deleteAllowed
protected boolean editAllowed
protected boolean moveAllowed
protected boolean addChildAllowed
protected double precedence
Constructor Detail |
---|
public UserLayoutNodeDescription()
public UserLayoutNodeDescription(IUserLayoutNodeDescription d)
UserLayoutNodeDescription(org.w3c.dom.Element xmlNode) throws PortalException
PortalException
Method Detail |
---|
public double getPrecedence()
getPrecedence
in interface IUserLayoutNodeDescription
public void setPrecedence(double setting)
setPrecedence
in interface IUserLayoutNodeDescription
public boolean isMoveAllowed()
isMoveAllowed
in interface IUserLayoutNodeDescription
public void setMoveAllowed(boolean setting)
setMoveAllowed
in interface IUserLayoutNodeDescription
public boolean isDeleteAllowed()
isDeleteAllowed
in interface IUserLayoutNodeDescription
public void setDeleteAllowed(boolean setting)
setDeleteAllowed
in interface IUserLayoutNodeDescription
public boolean isEditAllowed()
isEditAllowed
in interface IUserLayoutNodeDescription
public void setEditAllowed(boolean setting)
setEditAllowed
in interface IUserLayoutNodeDescription
public boolean isAddChildAllowed()
isAddChildAllowed
in interface IUserLayoutNodeDescription
public void setAddChildAllowed(boolean setting)
setAddChildAllowed
in interface IUserLayoutNodeDescription
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.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |