| java.lang.Object
 org.jasig.portal.layout.LayoutStructure
| LayoutStructure | | final public class LayoutStructure (Code) | | LayoutStructure represents a channel or folder in a layout.
version:
$Revision: 35797 $ $Date: 2005-05-16 10:27:27 -0700 (Mon, 16 May 2005) $
since:
uPortal 2.5 - before 2.5 this class existed as a public inner class of RDBMUserLayoutStore. |
| Constructor Summary | |
| public | LayoutStructure(int structId, int nextId, int childId, int chanId, String hidden, String unremovable, String immutable)
Instantiate a new LayoutStructure with the given configuration. | | public | LayoutStructure(int structId, int nextId, int childId, int chanId, String hidden, String unremovable, String immutable, String locale)
Instantiate a new LayoutStructure with the given configuration. |
| Method Summary | |
| public void | addFolderData(String folderName, String folderType)
Add information about the folder represented by this LayoutStructure. | | public void | addParameter(String paramName, String paramValue)
Add a parameter to this LayoutStructure. | | public int | getChanId()
Get the id of the channel represented by this LayoutStructure instance,
or zero if we do not represent a channel. | | public int | getChildId()
Get the id of the child of this LayoutStructure, or zero if we do not have
a child. | | public String | getLocale()
Get the locale of this LayoutStructure. | | public String | getName()
Get the name of the folder that this LayoutStructure represents, or null
if this LayoutStructure does not represent a folder. | | public int | getNextId()
Get the id of the next LayoutStructure or zero if there is no next LayoutStructure. | | public List | getParameters()
Get a List of StructureParameter instances representing parameters of
this LayoutStructure instance.
Prior to uPortal 2.5, this method would return null when there were no
parameters. | | public int | getStructId()
Get the id of this LayoutStructure. | | public 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.
Different layout management approaches may define differing types of
folders for their own purposes. | | public boolean | isChannel()
Returns true if this LayoutStructure represents a channel, false otherwise. | | public boolean | isHidden()
Return true if this LayoutStructure is hidden, false otherwise. | | public boolean | isImmutable()
Returns true if this LayoutStructure is immutable, false otherwise. | | public boolean | isUnremovable()
Return true if this structure is unremovable, false otherwise. | | public String | toString()
|
| LayoutStructure | | public LayoutStructure(int structId, int nextId, int childId, int chanId, String hidden, String unremovable, String immutable)(Code) | | Instantiate a new LayoutStructure with the given configuration.
Parameters:
structId - the id of this LayoutStructure
Parameters:
nextId - the id of the next sibling of this LayoutStructure
Parameters:
childId - the id of the first child of this LayoutStructure
Parameters:
chanId - the id of the channel represented by this LayoutStructure, or zero if we do not represent a channel
Parameters:
hidden - "T" or "Y" if this LayoutStructure is hidden
Parameters:
unremovable - "T" or "Y" if this LayoutStructure is unremovable
Parameters:
immutable - "T" or "Y" if this LayoutStructure is unchangeable |
| LayoutStructure | | public LayoutStructure(int structId, int nextId, int childId, int chanId, String hidden, String unremovable, String immutable, String locale)(Code) | | Instantiate a new LayoutStructure with the given configuration.
Parameters:
structId - the id of this LayoutStructure
Parameters:
nextId - the id of the next sibling of this LayoutStructure
Parameters:
childId - the id of the first child of this LayoutStructure
Parameters:
chanId - the id of the channel represented by this LayoutStructure, or zero if we do not represent a channel
Parameters:
hidden - "T" or "Y" if this LayoutStructure is hidden
Parameters:
unremovable - "T" or "Y" if this LayoutStructure is unremovable
Parameters:
immutable - "T" or "Y" if this LayoutStructure is unchangeable
Parameters:
locale - the locale of this LayoutStructure |
| addFolderData | | public void addFolderData(String folderName, String folderType)(Code) | | Add information about the folder represented by this LayoutStructure.
Parameters:
folderName - the name of the folder
Parameters:
folderType - the type of the folder |
| addParameter | | public void addParameter(String paramName, String paramValue)(Code) | | Add a parameter to this LayoutStructure.
Parameters:
paramName - the name of the parameter
Parameters:
paramValue - the value of the parameter |
| getChanId | | public int getChanId()(Code) | | Get the id of the channel represented by this LayoutStructure instance,
or zero if we do not represent a channel.
0 or the id of the channel |
| getChildId | | public int getChildId()(Code) | | Get the id of the child of this LayoutStructure, or zero if we do not have
a child.
0 or the id of our child. |
| getLocale | | public String getLocale()(Code) | | Get the locale of this LayoutStructure.
the locale of this LayoutStructure. |
| getName | | public String getName()(Code) | | Get the name of the folder that this LayoutStructure represents, or null
if this LayoutStructure does not represent a folder.
the name of this LayoutStructure. |
| getNextId | | public int getNextId()(Code) | | Get the id of the next LayoutStructure or zero if there is no next LayoutStructure.
0 or the id of the next layout structure. |
| getParameters | | public List getParameters()(Code) | | Get a List of StructureParameter instances representing parameters of
this LayoutStructure instance.
Prior to uPortal 2.5, this method would return null when there were no
parameters. Now we return an empty list when there are no parameters.
This simplifies consumers of this class, who can simply blithely iterate over
the empty list and no longer have to check for null.
a List of StructureParameter instances. |
| getStructId | | public int getStructId()(Code) | | Get the id of this LayoutStructure.
the id of this LayoutStructure. |
| getType | | public String getType()(Code) | | Get the String representing the type of the folder that this LayoutStructure
represents, or null if this LayoutStructure does not represent a folder.
Different layout management approaches may define differing types of
folders for their own purposes. The core types typically used by all
are: header, footer, and regular. The value returned is the value found
in the up_layout_struct table's type column. For instances of
LayoutStructure that represent a channel this method will return a
value of null.
a String representing the type of this layout structure. |
| isChannel | | public boolean isChannel()(Code) | | Returns true if this LayoutStructure represents a channel, false otherwise.
Otherwise is the case where this LayoutStructure represents a folder.
true if a channel, false if a folder. |
| isHidden | | public boolean isHidden()(Code) | | Return true if this LayoutStructure is hidden, false otherwise.
true if this LayoutStructure is hidden, false otherwise. |
| isImmutable | | public boolean isImmutable()(Code) | | Returns true if this LayoutStructure is immutable, false otherwise.
false if this LayoutStructure can be changed, true otherwise. |
| isUnremovable | | public boolean isUnremovable()(Code) | | Return true if this structure is unremovable, false otherwise.
false if this structure can be removed, true otherwise. |
|
|