|
Compoze Software, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectportlets.compoze.groupware.mail.FolderNavigation
This class represents folder navigation.
Nested Class Summary | |
static class |
FolderNavigation.FolderNode
This class represents a folder node in the navigation. |
static class |
FolderNavigation.FolderNodeComparator
This class represents the folder node comparator for sorting folder nodes. |
Constructor Summary | |
FolderNavigation(java.lang.String sSelectedFolderID,
java.lang.String[] expandFolderIDs)
Constructor. |
Method Summary | |
void |
addFolderNode(java.lang.String sID,
java.lang.String sName,
int iDepth,
boolean bHasSubFolders,
boolean bIsRoot,
int iCount,
int iUnreadCount,
int iType,
boolean bIsModifiable,
boolean bSupportSubFolders)
Adds a folder node. |
void |
addFolderNode(java.lang.String sID,
java.lang.String sName,
int iDepth,
boolean bHasSubFolders,
boolean bIsRoot,
int iCount,
int iUnreadCount,
int iType,
boolean bIsModifiable,
boolean bSupportSubFolders,
java.lang.String sParentID)
Adds a folder node. |
static java.lang.String[] |
adjustExpandFolderIDs(java.lang.String openFolderID,
java.lang.String closeFolderID,
java.lang.String expandFolderIDs)
Adjusts the expand folder IDs. |
static java.lang.String |
formatExpandFolderIDs(java.lang.String[] expandFolderIDs)
Formats the expand folder IDs. |
java.lang.String[] |
getExpandFolderIDs()
Gets the list of expanded folder IDs. |
java.util.List |
getNodes()
Gets the nodes. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FolderNavigation(java.lang.String sSelectedFolderID, java.lang.String[] expandFolderIDs)
sSelectedFolderID
- the selected folder ID (may not be null
)expandFolderIDs
- an array of folder IDs to expand (may not be null
)Method Detail |
public static java.lang.String formatExpandFolderIDs(java.lang.String[] expandFolderIDs)
expandFolderIDs
- an array of folder IDs to expand
public static java.lang.String[] adjustExpandFolderIDs(java.lang.String openFolderID, java.lang.String closeFolderID, java.lang.String expandFolderIDs)
openFolderID
- the folder ID to add to the expand array (null
or empty to ignore)closeFolderID
- the folder ID to remove from the expand array (null
or empty to ignore)expandFolderIDs
- a comma separated list of folder IDs to expand (may not be null
)
public void addFolderNode(java.lang.String sID, java.lang.String sName, int iDepth, boolean bHasSubFolders, boolean bIsRoot, int iCount, int iUnreadCount, int iType, boolean bIsModifiable, boolean bSupportSubFolders)
sID
- the folder IDsName
- the folder nameiDepth
- the depth of the folderbHasSubFolders
- true
if the folder has sub folders; false
otherwisebIsRoot
- true
if the folder is root; false
otherwiseiCount
- the message countiUnreadCount
- the unread message countiType
- the typebIsModifiable
- true
if the folder is modifiable; false
otherwisebSupportSubFolders
- true
if the folder supports sub-folders; false
otherwisepublic void addFolderNode(java.lang.String sID, java.lang.String sName, int iDepth, boolean bHasSubFolders, boolean bIsRoot, int iCount, int iUnreadCount, int iType, boolean bIsModifiable, boolean bSupportSubFolders, java.lang.String sParentID)
sID
- the folder IDsName
- the folder nameiDepth
- the depth of the folderbHasSubFolders
- true
if the folder has sub folders; false
otherwisebIsRoot
- true
if the folder is root; false
otherwiseiCount
- the message countiUnreadCount
- the unread message countiType
- the typebIsModifiable
- true
if the folder is modifiable; false
otherwisebSupportSubFolders
- true
if the folder supports sub-folders; false
otherwisesParentID
- the folder parent IDpublic java.util.List getNodes()
FolderNavigation.FolderNode
objects (unmodifiable)public java.lang.String[] getExpandFolderIDs()
|
Compoze Software, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |