com.plumtree.portalpages.common.editpage
Interface IPageLayoutModelRO

All Known Implementing Classes:

PageLayoutPlugInModel

public interface IPageLayoutModelRO

Interface IPageLayoutModelRO. This is the interface used by PageLayoutView.

Author:

michaeld

Method Summary

boolean	GetCanChangeLayout() Method GetCanChangeLayout.
boolean	GetCanChooseFreeForm() Method GetCanChooseFreeForm.
boolean	GetCanCreatePortlet() Method GetCanCreatePortlet.
int	GetClassID() Method GetClassID.
int	GetFolderID() Method GetFolderID.
boolean	GetHasFreeFormPortlet() Method GetHasFreeFormPortlet.
java.lang.String	GetInputValue(java.lang.String strName) Method GetInputValue.
int	GetObjectID() Method GetObjectID.
int	GetPageType() Method GetPageType.
int	GetPortletAlignment(int nPortletIndex) Method GetPortletAlignment.
int	GetPortletColumn(int nPortletIndex) Method GetPortletColumn.
int	GetPortletCount() Method GetPortletCount.
java.lang.String	GetPortletDescription(int nPortletIndex) Method GetPortletDescription.
int	GetPortletID(int nPortletIndex) Method GetPortletID.
boolean	GetPortletIsCommunityType(int nPortletIndex) Method GetPortletIsCommunityType.
boolean	GetPortletIsFromPT(int nPortletIndex) Method GetPortletIsFromPT.
java.lang.String	GetPortletName(int nPortletIndex) Method GetPortletName.
int	GetTableHeight() Method GetTableHeight.
boolean	GetUseDragDropLayout() Method GetUseDragDropLayout.
boolean	IsFreeFormLayoutAllowed() Method IsFreeFormLayoutAllowed.

Method Detail

GetCanChangeLayout

boolean GetCanChangeLayout()

Method GetCanChangeLayout. If this editor can choose the page layout type for this page, then this will return true.

Returns:

boolean

GetCanChooseFreeForm

boolean GetCanChooseFreeForm()

Method GetCanChooseFreeForm. If this editor can choose a free form gadget for this page, then this will return true.

Returns:

boolean

GetCanCreatePortlet

boolean GetCanCreatePortlet()

Method GetCanCreatePortlet. If this editor can create a gadget from a gadget template, then this will return true.

Returns:

boolean

GetPortletAlignment

int GetPortletAlignment(int nPortletIndex)

Method GetPortletAlignment. Gets the gadget alignment for the gadget at the given index.

Parameters:

nPortletIndex -

Returns:

int

GetPortletColumn

int GetPortletColumn(int nPortletIndex)

Method GetPortletColumn. Gets the gadget column for the gadget at the given index.

Parameters:

nPortletIndex -

Returns:

int

GetPortletCount

int GetPortletCount()

Method GetPortletCount. Gets the count of the gadgets on the page.

Returns:

int

GetPortletDescription

java.lang.String GetPortletDescription(int nPortletIndex)

Method GetPortletDescription. Gets the gadget description for the gadget at the given index.

Parameters:

nPortletIndex -

Returns:

String

GetPortletID

int GetPortletID(int nPortletIndex)

Method GetPortletID. Gets the gadget ID for the gadget at the given index.

Parameters:

nPortletIndex -

Returns:

int

GetPortletIsCommunityType

boolean GetPortletIsCommunityType(int nPortletIndex)

Method GetPortletIsCommunityType. Gets whether the gadget at the given index is of type community or not.

Parameters:

nPortletIndex -

Returns:

boolean

GetPortletIsFromPT

boolean GetPortletIsFromPT(int nPortletIndex)

Method GetPortletIsFromPT. Returns true if the gadget is from the page template.

Parameters:

nPortletIndex -

Returns:

boolean

GetPortletName

java.lang.String GetPortletName(int nPortletIndex)

Method GetPortletName. Gets the gadget name for the gadget at the given index.

Parameters:

nPortletIndex -

Returns:

String

GetHasFreeFormPortlet

boolean GetHasFreeFormPortlet()

Method GetHasFreeFormPortlet. Return true if the page has a free form portlet selected.

Returns:

boolean

GetInputValue

java.lang.String GetInputValue(java.lang.String strName)

Method GetInputValue. Get the value for the given input.

Parameters:

strName -

Returns:

String

IsFreeFormLayoutAllowed

boolean IsFreeFormLayoutAllowed()

Method IsFreeFormLayoutAllowed. Returns whether free form layouts can be selected.

Returns:

boolean

GetClassID

int GetClassID()

Method GetClassID. Gets the class ID of the object that opened this layout page.

Returns:

int

GetFolderID

int GetFolderID()

Method GetFolderID. Gets the Folder ID of the page that opened this layout page.

Returns:

int

GetObjectID

int GetObjectID()

Method GetObjectID. Gets the Object ID of the object that opened this layout page.

Returns:

int

GetPageType

int GetPageType()

Method GetPageType. Gets the page type of the page we are editing.

Returns:

int

GetTableHeight

int GetTableHeight()

Method GetTableHeight. Gets the height of the drag and drop table.

Returns:

int

GetUseDragDropLayout

boolean GetUseDragDropLayout()

Method GetUseDragDropLayout. Gets wether to use the drag drop layout or the alternate layout based upon which browser is being used.

Returns:

boolean