com.plumtree.portalpages.portlets.sitemap.prefs
Class SiteMapPortletPrefsModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IntrinsicPortletPrefsEditorModel
          com.plumtree.portalpages.portlets.sitemap.prefs.SiteMapPortletPrefsModel

All Implemented Interfaces:

ISiteMapPortletPrefsModelRO, IIntrinsicPortletPrefsModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class SiteMapPortletPrefsModel
extends IntrinsicPortletPrefsEditorModel
implements ISiteMapPortletPrefsModelRO

Intrinsic portlet prefs model, which extends the IntrinsicPortletPrefsEditorModel, uses the editor framework.

Version:

$Revision$

Author:

NaveenP

Field Summary

protected int	m_nFolderID
protected int	m_nNumLinks
protected int	m_nShowDescriptions
protected IPTSiteMapFolder	m_ptSiteMapFolder
static java.lang.String	SETTING_NAME_FOLDERID
static java.lang.String	SETTING_NAME_FOLDERNAME
static java.lang.String	SETTING_NAME_LINKORDER
static java.lang.String	SETTING_NAME_NUMLINKS
static java.lang.String	SETTING_NAME_SHOWDESC
static java.lang.String	STR_MVC_CLASS_NAME SiteMapPortletPrefs

Fields inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IntrinsicPortletPrefsEditorModel

m_bIsAdminPref, m_nCommunityID, m_nPageID, m_nPortletID, m_nPrefType, m_ptPortlet, m_ptSession, m_strPreviousURL, PREF_TYPE_ADMIN, PREF_TYPE_COMMUNITY, PREF_TYPE_PERSONAL, SETTINGSTYPE_ADMIN, SETTINGSTYPE_COMMUNITY, SETTINGSTYPE_COMMUNITYPORTLET, SETTINGSTYPE_PORTLET, SETTINGSTYPE_USER

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

SiteMapPortletPrefsModel()

Method Summary

void	ActionOnRepost() Modifies the object name on repost.
void	Cancel() Implement some code to execute when the user clicks on "Cancel".
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	CreateFolder() Create a site map folder for this portlet.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Load the community preferences for the portlet.
void	Finish() Implement some code to execute when the user clicks on "Finish".
int	GetFolderID()
ASQueryResultWrapper	GetLinks()
java.lang.String	GetName() Returns the Class name.
int	GetNumLinksToDisplay()
boolean	GetSiteMapFolderIsNull()
boolean	HasNoLinks()
boolean	OrderAlpha()
protected void	SaveMainPage(XPHashtable _htFormData) Saves the data on the Main page.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
boolean	ShowDescriptions()

Methods inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IntrinsicPortletPrefsEditorModel

CheckEditorAccessAndStart, GetCommunityId, GetEditorType, GetEnableApplyButton, GetHideLeftNav, GetIsEditorReadOnly, GetPortletFromSpace, GetPortletName, GetPrefType, GetRedirectAfterFinish, GetSettingValue, GetSettingValues, Init, InitializePortlet, RemoveSettingValue, SetEnableApplyButton, SetMemberVariablesFromQS, SetSettingValue

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

CleanupAllData, CleanupTempData, DoTaskAfterStore, DoTaskBeforeStore, DoTaskOnChangePage, DoTaskOnComeBackFromSubEditor, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEnableCancelButton, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IIntrinsicPortletPrefsModelRO

GetCommunityId, GetPortletName, GetPrefType

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

SiteMapPortletPrefs

See Also:

Constant Field Values

SETTING_NAME_FOLDERNAME

public static final java.lang.String SETTING_NAME_FOLDERNAME

See Also:

Constant Field Values

SETTING_NAME_FOLDERID

public static final java.lang.String SETTING_NAME_FOLDERID

See Also:

Constant Field Values

SETTING_NAME_LINKORDER

public static final java.lang.String SETTING_NAME_LINKORDER

See Also:

Constant Field Values

SETTING_NAME_SHOWDESC

public static final java.lang.String SETTING_NAME_SHOWDESC

See Also:

Constant Field Values

SETTING_NAME_NUMLINKS

public static final java.lang.String SETTING_NAME_NUMLINKS

See Also:

Constant Field Values

m_ptSiteMapFolder

protected IPTSiteMapFolder m_ptSiteMapFolder

m_nFolderID

protected int m_nFolderID

m_nNumLinks

protected int m_nNumLinks

m_nShowDescriptions

protected int m_nShowDescriptions

Constructor Detail

SiteMapPortletPrefsModel

public SiteMapPortletPrefsModel()

Method Detail

ActionOnRepost

public void ActionOnRepost()

Modifies the object name on repost.

Create

public java.lang.Object Create()

Description copied from class: EditorModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class EditorModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

CreateFolder

public void CreateFolder()

Create a site map folder for this portlet.

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Load the community preferences for the portlet.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

Finish

public void Finish()

Implement some code to execute when the user clicks on "Finish".

Specified by:

Finish in interface IRepostModel

Specified by:

Finish in class EditorModel

Cancel

public void Cancel()

Implement some code to execute when the user clicks on "Cancel".

Overrides:

Cancel in class EditorModel

GetFolderID

public int GetFolderID()

Specified by:

GetFolderID in interface ISiteMapPortletPrefsModelRO

Returns:

GetLinks

public ASQueryResultWrapper GetLinks()

Returns:

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

GetNumLinksToDisplay

public int GetNumLinksToDisplay()

Specified by:

GetNumLinksToDisplay in interface ISiteMapPortletPrefsModelRO

Returns:

See Also:

ISiteMapPortletPrefsModelRO.GetNumLinksToDisplay()

GetSiteMapFolderIsNull

public boolean GetSiteMapFolderIsNull()

Specified by:

GetSiteMapFolderIsNull in interface ISiteMapPortletPrefsModelRO

Returns:

HasNoLinks

public boolean HasNoLinks()

Specified by:

HasNoLinks in interface ISiteMapPortletPrefsModelRO

Returns:

boolean

OrderAlpha

public boolean OrderAlpha()

Specified by:

OrderAlpha in interface ISiteMapPortletPrefsModelRO

Returns:

See Also:

ISiteMapPortletPrefsModelRO.OrderAlpha()

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Specified by:

SavePage in class EditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

ShowDescriptions

public boolean ShowDescriptions()

Specified by:

ShowDescriptions in interface ISiteMapPortletPrefsModelRO

Returns:

SaveMainPage

protected void SaveMainPage(XPHashtable _htFormData)

Saves the data on the Main page.

Parameters:

_htFormData -