|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.layout.LayoutStructure
public final class LayoutStructure
LayoutStructure represents a channel or folder in a layout.
Field Summary | |
---|---|
private int |
chanId
The ID of any channel that this LayoutStructure instance is representing. |
private int |
childId
The ID of the LayoutStructure that is the child of this LayoutStructure. |
private boolean |
hidden
True if this LayoutStructure is hidden, false otherwise. |
private boolean |
immutable
True if this LayoutStructure cannot be changed, false otherwise. |
private java.lang.String |
locale
|
private static org.apache.commons.logging.Log |
LOG
|
private java.lang.String |
name
When this LayoutStructure represents a folder, the name of that folder. |
private int |
nextId
The ID of the LayoutStructure that is the next sibling of this LayoutStructure. |
private java.util.List |
parameters
A List of StructureParameter instances representing parameters to this LayoutStructure. |
private int |
structId
The ID of this LayoutStructure. |
private java.lang.String |
type
When this LayoutStructure represents a folder, the type of that folder. |
private boolean |
unremovable
True if this LayoutStructure cannot be removed, false otherwise. |
Constructor Summary | |
---|---|
LayoutStructure(int structId,
int nextId,
int childId,
int chanId,
java.lang.String hidden,
java.lang.String unremovable,
java.lang.String immutable)
Instantiate a new LayoutStructure with the given configuration. |
|
LayoutStructure(int structId,
int nextId,
int childId,
int chanId,
java.lang.String hidden,
java.lang.String unremovable,
java.lang.String immutable,
java.lang.String locale)
Instantiate a new LayoutStructure with the given configuration. |
Method Summary | |
---|---|
void |
addFolderData(java.lang.String folderName,
java.lang.String folderType)
Add information about the folder represented by this LayoutStructure. |
void |
addParameter(java.lang.String paramName,
java.lang.String paramValue)
Add a parameter to this LayoutStructure. |
int |
getChanId()
Get the id of the channel represented by this LayoutStructure instance, or zero if we do not represent a channel. |
int |
getChildId()
Get the id of the child of this LayoutStructure, or zero if we do not have a child. |
java.lang.String |
getLocale()
Get the locale of this LayoutStructure. |
java.lang.String |
getName()
Get the name of the folder that this LayoutStructure represents, or null if this LayoutStructure does not represent a folder. |
int |
getNextId()
Get the id of the next LayoutStructure or zero if there is no next LayoutStructure. |
java.util.List |
getParameters()
Get a List of StructureParameter instances representing parameters of this LayoutStructure instance. |
int |
getStructId()
Get the id of this LayoutStructure. |
java.lang.String |
getType()
Get the String representing the type of the folder that this LayoutStructure represents, or null if this LayoutStructure does not represent a folder. |
boolean |
isChannel()
Returns true if this LayoutStructure represents a channel, false otherwise. |
boolean |
isHidden()
Return true if this LayoutStructure is hidden, false otherwise. |
boolean |
isImmutable()
Returns true if this LayoutStructure is immutable, false otherwise. |
boolean |
isUnremovable()
Return true if this structure is unremovable, false otherwise. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private static final org.apache.commons.logging.Log LOG
private final int structId
private final int nextId
private final int childId
private final int chanId
private java.lang.String name
private java.lang.String type
private boolean hidden
private boolean unremovable
private boolean immutable
private final java.util.List parameters
private java.lang.String locale
Constructor Detail |
---|
public LayoutStructure(int structId, int nextId, int childId, int chanId, java.lang.String hidden, java.lang.String unremovable, java.lang.String immutable)
structId
- the id of this LayoutStructurenextId
- the id of the next sibling of this LayoutStructurechildId
- the id of the first child of this LayoutStructurechanId
- the id of the channel represented by this LayoutStructure, or zero if we do not represent a channelhidden
- "T" or "Y" if this LayoutStructure is hiddenunremovable
- "T" or "Y" if this LayoutStructure is unremovableimmutable
- "T" or "Y" if this LayoutStructure is unchangeablepublic LayoutStructure(int structId, int nextId, int childId, int chanId, java.lang.String hidden, java.lang.String unremovable, java.lang.String immutable, java.lang.String locale)
structId
- the id of this LayoutStructurenextId
- the id of the next sibling of this LayoutStructurechildId
- the id of the first child of this LayoutStructurechanId
- the id of the channel represented by this LayoutStructure, or zero if we do not represent a channelhidden
- "T" or "Y" if this LayoutStructure is hiddenunremovable
- "T" or "Y" if this LayoutStructure is unremovableimmutable
- "T" or "Y" if this LayoutStructure is unchangeablelocale
- the locale of this LayoutStructureMethod Detail |
---|
public void addFolderData(java.lang.String folderName, java.lang.String folderType)
folderName
- the name of the folderfolderType
- the type of the folderpublic boolean isChannel()
public void addParameter(java.lang.String paramName, java.lang.String paramValue)
paramName
- the name of the parameterparamValue
- the value of the parameterpublic int getNextId()
public int getChildId()
public int getChanId()
public int getStructId()
public boolean isHidden()
public boolean isImmutable()
public java.lang.String getLocale()
public java.lang.String getName()
public java.util.List getParameters()
public java.lang.String getType()
public boolean isUnremovable()
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 |