|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMyPortalModelRO
Model interface used by plugin navigation
Method Summary | |
---|---|
java.lang.Object[][] |
GetCollapsedOrErrorContent(int nPortletIndex)
Returns the markup which should be displayed in case of a collapsed or error portlet. |
int |
GetCommunityID()
Get the community ID of the community we are currently viewing. |
java.lang.String |
GetCommunityName()
Get the name of the community we are currently viewing. |
IPTQueryResult |
GetCommunityPages()
Get the pages in the community. |
boolean |
GetDisplayPortletHeaderDueToError(int nPortletIndex)
If there was an error, display the gadget header regardless of any other settings. |
int |
GetFirstPortletIndexInColumn(int nPortletColumn)
Get the first gadget index in the given column. |
IMyPortalModelHelper |
GetHelper()
Get the helper object for this model. |
java.lang.String |
GetIDStringForPortlet(int nPortletIndex)
Get the gadget ID string from the given index. |
boolean |
GetIsCommunityPage()
Get whether the current page is a community page. |
int |
GetLastPortletIndexInColumn(int nPortletColumn)
Get the last gadget index in the given column. |
ASURL |
GetPageASURL()
Get the ASURL for the page we are on. |
int |
GetPageID()
Get the page ID of the page we are currently viewing. |
java.lang.String |
GetPageName()
Get the name of the page we are currently viewing. |
int |
GetPageType()
Get the page type of the page we are currently viewing. |
java.lang.String |
GetPortletAdminPrefsURL(int nPortletIndex)
Get the gadget Admin Preference URL at the given index. |
boolean |
GetPortletCollapsed(int nPortletIndex)
Get the whether the gadget at the given index is collapsed. |
java.lang.String |
GetPortletCollapseExpandURL(int nPortletIndex,
java.lang.String strControl)
Get the gadget Collapse/Expand URL at the given index. |
int |
GetPortletColumnFromIndex(int nPortletIndex)
Get the gadget column from the given index. |
java.lang.String |
GetPortletCommunityPrefsURL(int nPortletIndex)
Get the gadget Community Preference URL at the given index. |
int |
GetPortletCount()
Get the number of gadgets on the page we are currently viewing. |
java.lang.String |
GetPortletDisabledMessage(int nPortletIndex)
Get the gadget's disabled message from the given index. |
boolean |
GetPortletEnabled(int nPortletIndex)
Get the whether the gadget at the given index is enabled. |
boolean |
GetPortletHasAdminPrefsURL(int nPortletIndex)
Get whether the gadget at the given index has a Admin Preference URL. |
boolean |
GetPortletHasCollapseExpandURL(int nPortletIndex)
Get whether the gadget at the given index has a Collapse/Expand URL. |
boolean |
GetPortletHasCommunityPrefsURL(int nPortletIndex)
Get whether the gadget at the given index has a Community Preference URL. |
boolean |
GetPortletHasHelpURL(int nPortletIndex)
Get whether the gadget at the given index has a help URL. |
boolean |
GetPortletHasRefreshButton(int nPortletIndex)
Returns whether the portlet at a given index has a Refresh button. |
boolean |
GetPortletHasTitleBar(int nPortletIndex)
Get whether a gadget has a title bar or not. |
boolean |
GetPortletHasUserPrefsURL(int nPortletIndex)
Get whether the gadget at the given index has a User Preference URL. |
java.lang.String |
GetPortletHelpURL(int nPortletIndex)
Get the gadget help URL at the given index. |
java.lang.Object[][] |
GetPortletHTMLTextFromIndex(int nGadgetIndex)
Get the gadget content from the given index. |
int |
GetPortletIDFromIndex(int nPortletIndex)
Get the gadget ID from the given index. |
boolean |
GetPortletIsMandatory(int nPortletIndex)
Get the whether the gadget at the given index is mandatory. |
int |
GetPortletLayoutId()
|
java.lang.String |
GetPortletNameFromIndex(int nPortletColumn)
Get the gadget name from the given index. |
java.lang.String |
GetPortletPrefButtonBoolean()
Get the PortletPrefButton boolean from the varpack. |
IXPList |
GetPortletPreferenceActionsData(int nPortletIndex)
Get the portlet pref actions. |
java.lang.String |
GetPortletRemoveURL(int nPortletIndex)
Get the gadget Remove URL at the given index. |
boolean |
GetPortletSupports508(int nPortletIndex)
Returns whether or not the gadget supports 508 mode |
int |
GetPortletSupportsPersonalization(int nPortletIndex)
Returns a bitmask of the types of personalization this portlet supports. |
java.lang.String |
GetPortletUserPrefsURL(int nPortletIndex)
Get the gadget User Preference URL at the given index. |
java.lang.String |
GetPortletUUID(int nPortletIndex)
Get the UUID of the portlet. |
int |
GetProfileID()
Get the profile ID of the user being viewed on the user profile community. |
XPArrayList |
GetRecentlyAddedPortlets()
Returns the id of the portlet that was recently added to the page |
int |
GetRecentlyCollapsedExpandedPortlet()
Returns the id of the portlet that was recently collapsed from the page |
int |
GetRecentlyRemovedPortlet()
Returns the id of the portlet that was recently removed from the page |
IPTSession |
GetSession()
Get the current IPTSession. |
void |
SetDisplayPortletHeaderDueToError(int nPortletIndex,
boolean bDisplayHeader)
If there was an error, display the gadget header regardless of any other settings. |
boolean |
UsesPortletLayout()
If the current page has an adaptive Portlet Layout set. |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject |
---|
GetName |
Method Detail |
---|
int GetCommunityID()
java.lang.String GetCommunityName()
IPTQueryResult GetCommunityPages()
int GetFirstPortletIndexInColumn(int nPortletColumn)
nPortletColumn
- nPortletColumn
boolean GetPortletCollapsed(int nPortletIndex)
nPortletIndex
- nPortletIndex
int GetPortletColumnFromIndex(int nPortletIndex)
nPortletIndex
- nPortletIndex
int GetPortletCount()
java.lang.String GetPortletDisabledMessage(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletEnabled(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetDisplayPortletHeaderDueToError(int nPortletIndex)
nPortletIndex
- nPortletIndex
void SetDisplayPortletHeaderDueToError(int nPortletIndex, boolean bDisplayHeader)
nPortletIndex
- nPortletIndexjava.lang.Object[][] GetPortletHTMLTextFromIndex(int nGadgetIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletHasHelpURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletHasAdminPrefsURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletHasCommunityPrefsURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletHasUserPrefsURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletHasCollapseExpandURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.String GetPortletUUID(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletHasTitleBar(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.String GetPortletHelpURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.String GetPortletAdminPrefsURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.String GetPortletCommunityPrefsURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.String GetPortletUserPrefsURL(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.String GetPortletCollapseExpandURL(int nPortletIndex, java.lang.String strControl)
nPortletIndex
- nPortletIndexstrControl
- strControl
java.lang.String GetPortletRemoveURL(int nPortletIndex)
nPortletIndex
-
int GetPortletIDFromIndex(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletIsMandatory(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.String GetPortletNameFromIndex(int nPortletColumn)
nPortletColumn
- nPortletIndex
java.lang.String GetIDStringForPortlet(int nPortletIndex)
nPortletIndex
- nPortletIndex
boolean GetPortletSupports508(int nPortletIndex)
int GetPortletSupportsPersonalization(int nPortletIndex)
IMyPortalModelHelper GetHelper()
boolean GetIsCommunityPage()
int GetLastPortletIndexInColumn(int nPortletColumn)
nPortletColumn
- nPortletColumn
ASURL GetPageASURL()
int GetPageID()
java.lang.String GetPageName()
int GetPageType()
int GetPortletLayoutId()
boolean UsesPortletLayout()
IPTSession GetSession()
java.lang.String GetPortletPrefButtonBoolean()
boolean GetPortletHasRefreshButton(int nPortletIndex)
nPortletIndex
- nPortletIndex
java.lang.Object[][] GetCollapsedOrErrorContent(int nPortletIndex)
nPortletIndex
-
XPArrayList GetRecentlyAddedPortlets()
int GetRecentlyRemovedPortlet()
int GetRecentlyCollapsedExpandedPortlet()
int GetProfileID()
IXPList GetPortletPreferenceActionsData(int nPortletIndex)
nPortletIndex
-
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |