|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.activityspace.AClearModel com.plumtree.portalpages.browsing.portletpreview.PreviewPortletModel
public class PreviewPortletModel
File: PreviewPortletModel.java ----------------------------- Model for entire preview/invitation (and invitation join) functionality.
Field Summary | |
---|---|
static int |
INVITEHEADER
Constant: Invite Header Bar |
AActivitySpace |
m_asOwner
Activity Space |
boolean |
m_bAlwaysCommunity
Whether to always use community preview mode |
boolean |
m_bErrorPage
Is it an Error Page |
boolean |
m_bPortletChecked
Portlet Checked on selection page (for checkbox) |
boolean |
m_bPortletEnabled
Is Portlet Enabled |
int |
m_nPageID
Page ID |
int |
m_nPortletAlignment
Portlet Alignment |
int |
m_nPortletID
Portlet ID |
int |
m_nPortletIndex
Portlet Index on selection page (for checkbox) |
int |
m_nPreviewStatus
Preview Status |
IPTSession |
m_ptSession
Session |
java.lang.String |
m_strDisabledMessage
Disabled Message |
java.lang.String |
m_strHostPageURI
Host Page URI |
java.lang.String |
m_strJavascriptOverride
Add Portlet Javascript override |
java.lang.String |
m_strPortletDesc
Localized Portlet Description |
java.lang.String |
m_strPortletName
Localized Portlet Name |
java.lang.String |
m_strRawHeaders
|
static int |
PREVIEWHEADER
Constant: Preview Header Bar for preview only (as in Portlet Editor) |
static int |
SEARCHHEADER
Constant: Invite Header Bar |
static int |
SELECTIONPREVIEWHEADER
Constant: Preview Header Bar for Selection Page |
static java.lang.String |
STR_MVC_CLASS_NAME
|
Constructor Summary | |
---|---|
PreviewPortletModel()
|
Method Summary | |
---|---|
void |
AddPortletInPage()
Add Portlet In Page - adds gadget to the specified user's page |
java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
void |
Finish()
Implement some code to execute when the user clicks on "Finish". |
java.lang.String |
GetAddPortletJavaScriptOverride()
Get Add Portlet Javascript override. |
XPArrayList |
GetAllCommunitiesUsingPortlet()
Method GetAllCommunitiesUsingPortlet. |
boolean |
GetAlwaysUseCommunityPreview()
Returns true if the community preview mode should be used even if the portlet is not community-only |
java.lang.String |
GetDefaultMyPageURL()
Get Default MyPage URL |
IASQueryResult |
GetMyPages()
Get My Pages |
java.lang.String |
GetMyPageURL()
Get MyPage URL |
java.lang.String |
GetName()
Get Object Name |
java.lang.Object |
GetNewTempData()
This method returns a new temporary data object. |
int |
GetPageID()
Get the page id |
java.lang.String |
GetPageName()
Get the page name |
AActivitySpace |
GetParent()
Get AS Parent |
int |
GetPortletAlignment()
Get Portlet Alignment |
java.lang.String |
GetPortletDescription()
Get Portlet Description |
java.lang.String |
GetPortletDisabledMessage()
Get Disabled Message if portlet is disabled |
java.lang.Object[][] |
GetPortletHTMLText()
Get Portlet HTML Text |
int |
GetPortletID()
Get the gadget id |
int |
GetPortletIndex()
Get the gadget index for selection page |
java.lang.String |
GetPortletName()
Get Portlet Name |
java.lang.String |
GetPortletPreviewURL()
Get Preview Portlet URL |
int |
GetPortletType()
Returns the gadget type |
Redirect |
GetRedirectAfterFinish()
Returns the Redirect object (this is were we need to go at the end of the Editor). |
IPTSession |
GetSession()
Returns the user session |
int |
GetUserID()
Returns the user ID |
void |
Init(AActivitySpace parent)
This method initializes the model. |
boolean |
IsErrorPage()
IsErrorPage |
boolean |
IsFooter()
Is Portlet Footer |
boolean |
IsFreeForm()
Is Portlet FreeForm |
boolean |
IsHeader()
Is Portlet Header |
boolean |
IsNarrow()
Is Portlet Narrow |
boolean |
IsNone()
Is Portlet None |
boolean |
IsPortletChecked()
Check if Portlet is already selected |
boolean |
IsPortletEnabled()
Is Portlet Enabled |
boolean |
IsPortletInPage()
Is Portlet In Page - checks to if the gadget is already in the user's page that's specified |
boolean |
IsPortletInvitePage()
Is Portlet Invite Page |
boolean |
IsPortletSearchPreviewPage()
Is Portlet Search Preview Page |
boolean |
IsPortletSelectionPreviewPage()
Is Portlet Selection Preview Page |
boolean |
IsWide()
Is Portlet Wide |
int |
SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument. |
void |
SetAddPortletJavaScriptOverride(java.lang.String _strOverride)
Set the Add Portlet Javascript override. |
void |
SetAlwaysUseCommunityPreview(boolean b)
Tells the model that community preview mode should always be used, even if the portlet is not community-only |
void |
SetErrorPage(boolean bSetErrorPage)
SetErrorPage |
void |
SetHostPageURI(java.lang.String strHostPageURI)
Sets the host page URI that is later used to initialize the AppDataObject |
void |
SetPageID(int nPageID)
Set The Page ID |
void |
SetPortletChecked(boolean bPortletChecked)
|
void |
SetPortletID(int nPortletID)
Set Portlet ID |
void |
SetPortletIndex(int nPortletIndex)
|
void |
SetPortletToInvitePage()
Set to use Invite Header |
void |
SetPortletToPreviewPage()
Set to use Preview Header |
void |
SetPortletToSearchPreviewPage()
Set to use Search Preview Header |
void |
SetPortletToSelectionPreviewPage()
Set to use Selection Preview Header |
void |
SetRawHeaders(java.lang.String strRawHeaders)
|
void |
SetupIntrinsicPortlet(java.lang.String _strPortletClass,
java.lang.String _strStorageName)
Register model, view, and control for intrinsic portlet. |
boolean |
UserHasMyPageAccess()
User Has My Page Access |
boolean |
UserHasReadAccess()
User Has Read Access |
boolean |
UserHasSelectAccess()
User Has Select Access |
Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel |
---|
CleanupAllData, CleanupTempData, GetTempData |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel |
---|
CleanupAllData, CleanupTempData |
Field Detail |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final int SELECTIONPREVIEWHEADER
public static final int INVITEHEADER
public static final int PREVIEWHEADER
public static final int SEARCHHEADER
public boolean m_bAlwaysCommunity
public int m_nPortletID
public int m_nPreviewStatus
public boolean m_bErrorPage
public boolean m_bPortletChecked
public int m_nPortletIndex
public java.lang.String m_strHostPageURI
public java.lang.String m_strRawHeaders
public int m_nPageID
public AActivitySpace m_asOwner
public IPTSession m_ptSession
public java.lang.String m_strPortletName
public java.lang.String m_strPortletDesc
public int m_nPortletAlignment
public boolean m_bPortletEnabled
public java.lang.String m_strDisabledMessage
public java.lang.String m_strJavascriptOverride
Constructor Detail |
---|
public PreviewPortletModel()
Method Detail |
---|
public java.lang.Object GetNewTempData()
AClearModel
GetNewTempData
in class AClearModel
com.plumtree.uiinfrastructure.activityspace.AClearModel#GetNewm_TempData()
public void AddPortletInPage()
AddPortletInPage
in interface IPreviewPortletModelRO
int
- nPageIDpublic java.lang.Object Create()
AClearModel
Create
in interface IManagedObject
Create
in class AClearModel
IManagedObject.Create()
public void Finish()
IRepostModel
Finish
in interface IRepostModel
IRepostModel.Finish()
public java.lang.String GetAddPortletJavaScriptOverride()
IPreviewPortletModelRO
GetAddPortletJavaScriptOverride
in interface IPreviewPortletModelRO
IPreviewPortletModelRO.GetAddPortletJavaScriptOverride()
public java.lang.String GetDefaultMyPageURL()
GetDefaultMyPageURL
in interface IPreviewPortletModelRO
public int GetPortletAlignment()
GetPortletAlignment
in interface IPreviewPortletModelRO
public java.lang.Object[][] GetPortletHTMLText()
GetPortletHTMLText
in interface IPreviewPortletModelRO
public int GetPortletID()
IPreviewPortletModelRO
GetPortletID
in interface IPreviewPortletModelRO
IPreviewPortletModelRO.GetPortletID()
public int GetPortletIndex()
IPreviewPortletModelRO
GetPortletIndex
in interface IPreviewPortletModelRO
IPreviewPortletModelRO.GetPortletIndex()
public java.lang.String GetPortletName()
GetPortletName
in interface IPreviewPortletModelRO
public java.lang.String GetPortletDescription()
GetPortletDescription
in interface IPreviewPortletModelRO
public boolean IsPortletEnabled()
IsPortletEnabled
in interface IPreviewPortletModelRO
public java.lang.String GetPortletDisabledMessage()
GetPortletDisabledMessage
in interface IPreviewPortletModelRO
public java.lang.String GetPortletPreviewURL()
GetPortletPreviewURL
in interface IPreviewPortletModelRO
public boolean GetAlwaysUseCommunityPreview()
GetAlwaysUseCommunityPreview
in interface IPreviewPortletModelRO
public void SetAlwaysUseCommunityPreview(boolean b)
public int GetPortletType()
GetPortletType
in interface IPreviewPortletModelRO
public java.lang.String GetMyPageURL()
GetMyPageURL
in interface IPreviewPortletModelRO
public IASQueryResult GetMyPages()
GetMyPages
in interface IPreviewPortletModelRO
public java.lang.String GetName()
GetName
in interface IMVCObject
GetName
in class AClearModel
IMVCObject.GetName()
public int GetPageID()
IPreviewPortletModelRO
GetPageID
in interface IPreviewPortletModelRO
com.plumtree.portalpages.browsing.portletpreview.IPreviewPortletModel#GetPageID()
public java.lang.String GetPageName()
IPreviewPortletModelRO
GetPageName
in interface IPreviewPortletModelRO
com.plumtree.portalpages.browsing.portletpreview.IPreviewPortletModel#GetPageID()
public AActivitySpace GetParent()
public Redirect GetRedirectAfterFinish()
IRepostModel
GetRedirectAfterFinish
in interface IRepostModel
IRepostModel.GetRedirectAfterFinish()
public IPTSession GetSession()
IPreviewPortletModelRO
GetSession
in interface IPreviewPortletModelRO
IPreviewPortletModelRO.GetSession()
public int GetUserID()
IPreviewPortletModelRO
GetUserID
in interface IPreviewPortletModelRO
IPreviewPortletModelRO.GetUserID()
public void Init(AActivitySpace parent)
IModel
Init
in interface IModel
Init
in class AClearModel
parent
- the parent Activity Spacecom.plumtree.xpshared.activityspace.IModel#Init()
public boolean IsErrorPage()
IsErrorPage
in interface IPreviewPortletModelRO
boolean
- public boolean IsFooter()
public boolean IsFreeForm()
public boolean IsPortletChecked()
IsPortletChecked
in interface IPreviewPortletModelRO
public boolean IsPortletInPage()
IsPortletInPage
in interface IPreviewPortletModelRO
int
- nPageIDpublic boolean IsPortletInvitePage()
IsPortletInvitePage
in interface IPreviewPortletModelRO
public boolean IsPortletSearchPreviewPage()
IsPortletSearchPreviewPage
in interface IPreviewPortletModelRO
public boolean IsPortletSelectionPreviewPage()
IsPortletSelectionPreviewPage
in interface IPreviewPortletModelRO
public boolean IsHeader()
public boolean IsNarrow()
IsNarrow
in interface IPreviewPortletModelRO
public boolean IsNone()
public boolean IsWide()
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
IRepostModel
SavePage
in interface IRepostModel
IRepostModel.SavePage(String, XPHashtable)
public void SetAddPortletJavaScriptOverride(java.lang.String _strOverride)
public void SetErrorPage(boolean bSetErrorPage)
boolean
- public void SetPortletChecked(boolean bPortletChecked)
sPortletChecked
- public void SetPortletID(int nPortletID)
int
- nPortletIDpublic void SetPortletIndex(int nPortletIndex)
nPortletIndex
- public void SetPortletToInvitePage()
public void SetPortletToPreviewPage()
public void SetPortletToSearchPreviewPage()
public void SetPortletToSelectionPreviewPage()
public void SetHostPageURI(java.lang.String strHostPageURI)
strHostPageURI
- strHostPageURIpublic void SetPageID(int nPageID)
int
- public void SetRawHeaders(java.lang.String strRawHeaders)
strRawHeaders
- public void SetupIntrinsicPortlet(java.lang.String _strPortletClass, java.lang.String _strStorageName)
_strPortletClass
- Class identifier for portlet_strStorageName
- Storage name for portlet
XPException
- Exception thrown if model, view, or control is not
registered successfully.public boolean UserHasReadAccess()
IPreviewPortletModelRO
UserHasReadAccess
in interface IPreviewPortletModelRO
com.plumtree.portalpages.browsing.portletpreview.IPreviewPortletModel#UserHasReadAccess()
public boolean UserHasSelectAccess()
IPreviewPortletModelRO
UserHasSelectAccess
in interface IPreviewPortletModelRO
com.plumtree.portalpages.browsing.portletpreview.IPreviewPortletModel#UserHasSelectAccess()
public boolean UserHasMyPageAccess()
IPreviewPortletModelRO
UserHasMyPageAccess
in interface IPreviewPortletModelRO
IPreviewPortletModelRO.UserHasMyPageAccess()
public XPArrayList GetAllCommunitiesUsingPortlet()
GetAllCommunitiesUsingPortlet
in interface IPreviewPortletModelRO
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |