|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.compoundlist.ASCompoundList
public class ASCompoundList
List to store different types of URLs, primarily URLs to various portal areas.
Field Summary | |
---|---|
static int |
ENTRYTYPE_COMMPTEMPL
|
static int |
ENTRYTYPE_DIRTEMPL
|
static int |
ENTRYTYPE_DOCTEMPL
|
static int |
ENTRYTYPE_EDITORTEMPL
|
static int |
ENTRYTYPE_FULLINTERNALURL
|
static int |
ENTRYTYPE_FULLURL
|
static int |
ENTRYTYPE_GENERICTEMPL
|
static int |
ENTRYTYPE_MYPAGETEMPL
|
static int |
ENTRYTYPE_PREFSTEMPL
|
static int |
ENTRYTYPE_SITEMAPROOTTEMPL
|
static int |
ENTRYTYPE_STRINGLABEL
Constant values of the different types of URLs the list stores. |
static int |
ENTRYTYPE_USERTEMPL
|
static int |
NEWASTYPE_CREATENEW
Constant values of the different types of getting the Activity Space. |
static int |
NEWASTYPE_GETCACHED
|
static int |
NEWASTYPE_GETIFCACHED
|
Constructor Summary | |
---|---|
ASCompoundList()
Creates a new ASCompoundList object. |
Method Summary | |
---|---|
void |
AddCommPageURL(java.lang.String label,
int nCommID,
int nPageID)
Adds a Community page URL |
void |
AddCommPageURL(java.lang.String label,
int nCommID,
int nPageID,
java.lang.String strDescription,
int nProfileID)
Adds a User Profile Community Page URL |
void |
AddCommPreviewPageURL(java.lang.String label,
int nCommID,
int nPageID,
java.lang.String strDescription)
Adds a Community Preview URL |
void |
AddCompoundList(ICPListEntryIterator list)
Adds the content of another ASCompoundList |
void |
AddDirectoryURL(java.lang.String label,
int nMode,
int nFolderID)
Adds a Directory URL |
void |
AddDirectoryURL(java.lang.String label,
int nMode,
int nFolderID,
java.lang.String strDescription)
Adds a Directory URL with description |
void |
AddDocumentURL(java.lang.String label,
int nDocID)
Adds an URL to a directory document |
void |
AddDocumentURL(java.lang.String label,
int nDocID,
java.lang.String strDescription)
Adds an URL to a directory document with description |
void |
AddEditorPageURL(java.lang.String label,
java.lang.String editor,
java.lang.String control,
int nEditorType)
Adds an URL to an editor |
void |
AddEditorPageURL(java.lang.String label,
java.lang.String editor,
java.lang.String control,
java.lang.String page,
java.lang.String[] paramNames,
java.lang.String[] paramValues)
Adds an URL to an editor with additional parameters. |
void |
AddFullURL(java.lang.String label,
java.lang.String url)
Adds an external URL |
void |
AddFullURL(java.lang.String label,
java.lang.String url,
java.lang.String strDescription)
Adds an external URL with description |
void |
AddGenericURL(java.lang.String label,
java.lang.String strAS,
java.lang.String[] paramNames,
java.lang.String[] paramValues,
int nNewASType)
Adds a generic portal URL |
void |
AddInternalFullURL(java.lang.String label,
java.lang.String url)
Adds a full URL for a portal page Use this URL type instead of AddFullURL for portal pages since ENTRYTYPE_FULLURL URL type will open in a popup if displayoptions specify external URL to open in a pop. |
void |
AddLabel(java.lang.String label)
Adds just a label |
void |
AddMyPageURL(java.lang.String label,
int nPageID)
Adds a Mypage URL |
void |
AddPreferencesURL(java.lang.String label,
java.lang.String strPrefsPage)
Adds a User Preference Page URL |
void |
AddSiteMapRootURL(java.lang.String label,
int nCommID,
int nMode,
boolean bIsPreview)
Adds a Community Knowledge Directory Root URL |
void |
AddUserProfileURL(java.lang.String label,
int nUserID)
Adds a User Profile URL |
void |
AddUserProfileURL(java.lang.String label,
int nUserID,
java.lang.String strDescription)
Adds a User Profile URL with description |
ListEntry |
GetEntry()
Gets the current entry ResetIterator and GetNextEntry will get the first entry in the list. |
ListEntry |
GetEntryAtIndex(int nIndex)
Gets an entry at a specific entry |
void |
GetIterator()
Reset the Iterator |
int |
GetTotalCount()
Get the number of entries in the list |
boolean |
Next()
Advances the iterator to next entry |
void |
SetImageForLastAddedURL(PTImageType image,
PTImageType image2,
java.lang.String strImageAltText)
Assigns a two part image to the entry last added to the list |
void |
SetImageForLastAddedURL(PTImageType image,
java.lang.String strImageAltText)
Assigns an image to the entry last added to the list |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ENTRYTYPE_STRINGLABEL
public static final int ENTRYTYPE_FULLURL
public static final int ENTRYTYPE_COMMPTEMPL
public static final int ENTRYTYPE_MYPAGETEMPL
public static final int ENTRYTYPE_DIRTEMPL
public static final int ENTRYTYPE_EDITORTEMPL
public static final int ENTRYTYPE_PREFSTEMPL
public static final int ENTRYTYPE_GENERICTEMPL
public static final int ENTRYTYPE_DOCTEMPL
public static final int ENTRYTYPE_USERTEMPL
public static final int ENTRYTYPE_SITEMAPROOTTEMPL
public static final int ENTRYTYPE_FULLINTERNALURL
public static final int NEWASTYPE_CREATENEW
public static final int NEWASTYPE_GETCACHED
public static final int NEWASTYPE_GETIFCACHED
Constructor Detail |
---|
public ASCompoundList()
Method Detail |
---|
public void AddCommPageURL(java.lang.String label, int nCommID, int nPageID)
label
- String to displaynCommID
- Community IDnPageID
- Community Page IDpublic void AddCommPageURL(java.lang.String label, int nCommID, int nPageID, java.lang.String strDescription, int nProfileID)
label
- String to displaynCommID
- Community IDnPageID
- Community Page IDstrDescription
- Description for the user profilenProfileID
- Profile User IDpublic void AddCommPreviewPageURL(java.lang.String label, int nCommID, int nPageID, java.lang.String strDescription)
label
- String to displaynCommID
- Community IDnPageID
- Communiyt Page IDstrDescription
- Description for the Communitypublic void AddSiteMapRootURL(java.lang.String label, int nCommID, int nMode, boolean bIsPreview)
label
- String to displaynCommID
- Community IDnMode
- Browse or Edit ModebIsPreview
- Is this page in preview modepublic void AddCompoundList(ICPListEntryIterator list)
list
- ASCompoundList, does nothing if nullpublic void AddDirectoryURL(java.lang.String label, int nMode, int nFolderID)
label
- String to displaynMode
- Browse or Edit ModenFolderID
- ID of Folder to displaypublic void AddDirectoryURL(java.lang.String label, int nMode, int nFolderID, java.lang.String strDescription)
label
- String to displaynMode
- Browse or Edit ModenFolderID
- ID of Folder to displaystrDescription
- Description of folderpublic void AddDocumentURL(java.lang.String label, int nDocID)
label
- String to displaynDocID
- ID of documentpublic void AddDocumentURL(java.lang.String label, int nDocID, java.lang.String strDescription)
label
- String to displaynDocID
- ID of documentstrDescription
- Document descriptionpublic void AddEditorPageURL(java.lang.String label, java.lang.String editor, java.lang.String control, int nEditorType)
label
- String to displayeditor
- Editor Activityspace IDcontrol
- Editor Control IDnEditorType
- Editor type constantpublic void AddEditorPageURL(java.lang.String label, java.lang.String editor, java.lang.String control, java.lang.String page, java.lang.String[] paramNames, java.lang.String[] paramValues)
label
- String to displayeditor
- Editor Activityspace IDcontrol
- Editor Control IDpage
- Editor Page IDparamNames
- String array of parameter names, each name element must
have a corresponding value element in paramValuesparamValues
- String array of parameter values, each value element must
have a corresponding name element in paramNamespublic void AddInternalFullURL(java.lang.String label, java.lang.String url)
label
- url
- public void AddFullURL(java.lang.String label, java.lang.String url)
label
- String to displayurl
- The full url to an external site (including http://)public void AddFullURL(java.lang.String label, java.lang.String url, java.lang.String strDescription)
label
- String to displayurl
- The full url to an external site (including http://)strDescription
- Description of external URLpublic void AddGenericURL(java.lang.String label, java.lang.String strAS, java.lang.String[] paramNames, java.lang.String[] paramValues, int nNewASType)
label
- String to displaystrAS
- Activityspace IDparamNames
- String array of parameter names, each name element must
have a corresponding value element in paramValuesparamValues
- String array of parameter values, each value element must
have a corresponding name element in paramNamesnNewASType
- How to retrieve the activityspace, use NEWSASTYPE_ constantpublic void AddLabel(java.lang.String label)
label
- String to displaypublic void AddMyPageURL(java.lang.String label, int nPageID)
label
- String to displaynPageID
- Mypage IDpublic void AddPreferencesURL(java.lang.String label, java.lang.String strPrefsPage)
label
- String to displaystrPrefsPage
- Preference Page IDpublic void AddUserProfileURL(java.lang.String label, int nUserID)
label
- String to displaynUserID
- The ID of the userpublic void AddUserProfileURL(java.lang.String label, int nUserID, java.lang.String strDescription)
label
- String to displaynUserID
- The ID of the userstrDescription
- Description of the userpublic ListEntry GetEntry()
GetEntry
in interface ICPListEntryIterator
public ListEntry GetEntryAtIndex(int nIndex)
GetEntryAtIndex
in interface ICPListEntryIterator
nIndex
- Index of the entry
public void GetIterator()
GetIterator
in interface ICPListEntryIterator
public int GetTotalCount()
GetTotalCount
in interface ICPListEntryIterator
public boolean Next()
Next
in interface ICPListEntryIterator
public void SetImageForLastAddedURL(PTImageType image, java.lang.String strImageAltText)
image
- Image construct for the image to addstrImageAltText
- Alt String for the imagepublic void SetImageForLastAddedURL(PTImageType image, PTImageType image2, java.lang.String strImageAltText)
image
- Image construct for the first imageimage2
- Image construct for the second imagestrImageAltText
- Alt string for both images
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |