com.plumtree.server
Interface IPTMyPortalGadgetContent

All Superinterfaces:
IPTUnknown

public interface IPTMyPortalGadgetContent
extends IPTUnknown

IPTMyPortalGadgetContent

Author:
Self-Service Communities

Method Summary
 int Find(int nGadgetID)
          Find the index of a gadget using a gadget id.
 java.lang.Object[][] GetCollapsedOrErrorContent(int iIndex)
          Gets the content that should be displayed for this portlet if it's in a collapsed or error state.
 java.lang.Object[][] GetContent(int nIndex)
          Get the content of the gadget at a particular index.
 int GetCount()
          Get the number of gadgets represented by this object.
 java.lang.String GetDisabledMessage(int nIndex)
          Get the disabled message for a gadget at a particular index.
 boolean GetEnabled(int nIndex)
          Get whether the gadget at a particular index is enabled.
 IPTGadget GetGadget(int nIndex)
          Get the IPTGadget object for the gadget at a particular index.
 int GetGadgetAlignment(int nIndex)
          Get the alignment of of the gadget at particular index.
 int GetGadgetColumn(int nIndex)
          Get the column of the gadget at a particular index.
 int GetGadgetID(int nIndex)
          Get the ID of the gadget at a particular index.
 java.lang.String GetGadgetName(int nIndex)
          Get the name of the gadget at a particular index.
 java.lang.String GetGadgetUUID(int nIndex)
          Get the UUID of the portlet.
 boolean GetHasHelpURL(int nIndex)
          Get whether the gadget at a particular index has a help URL or not.
 boolean GetHasRefreshButton(int nIndex)
          Get whether the portlet at a particular index has a refresh button or not.
 int GetSupportsPersonalization(int nIndex)
          Get the gadget at a particular index's personalization value, which can then be bitmasked with to a type in PT_GADGETPERSONALIZATION_ROLES.
 boolean GetSupportsUserInterface(int nIndex)
          Get whether or not the gadget at a particular index supports non-standard user interfaces.
 boolean GetSuppressTitleBar(int nIndex)
          Get whether the gadget at a particular index is has a suppressed title bar or not.
 int GetTopicPos(int nIndex)
          Get TopicPos (for ordering of gadgets) for a particular gadget.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetCount

int GetCount()
Get the number of gadgets represented by this object.

Returns:
int - number of gadgets

Find

int Find(int nGadgetID)
Find the index of a gadget using a gadget id.

Parameters:
nGadgetID - - gadget id to search for
Returns:
int - index of id. if not found, returns -1

GetGadgetID

int GetGadgetID(int nIndex)
Get the ID of the gadget at a particular index.

Parameters:
nIndex - - index of the gadget
Returns:
int - gadget id

GetGadgetName

java.lang.String GetGadgetName(int nIndex)
Get the name of the gadget at a particular index.

Parameters:
nIndex - - index of the gadget
Returns:
String - gadget name

GetGadgetAlignment

int GetGadgetAlignment(int nIndex)
Get the alignment of of the gadget at particular index.

Parameters:
nIndex - - index of the gadget
Returns:
int - gadget name

GetGadget

IPTGadget GetGadget(int nIndex)
Get the IPTGadget object for the gadget at a particular index.

Parameters:
nIndex - - index of the gadget
Returns:
IPTGadget - gadget object

GetEnabled

boolean GetEnabled(int nIndex)
Get whether the gadget at a particular index is enabled.

Parameters:
nIndex - - index of the gadget
Returns:
boolean - enabled or disabled

GetGadgetColumn

int GetGadgetColumn(int nIndex)
Get the column of the gadget at a particular index.

Parameters:
nIndex - - index of the gadget
Returns:
int - column number

GetContent

java.lang.Object[][] GetContent(int nIndex)
Get the content of the gadget at a particular index.

Parameters:
nIndex - - index of the gadget
Returns:
Object[][] - content markup for the gadget

GetTopicPos

int GetTopicPos(int nIndex)
Get TopicPos (for ordering of gadgets) for a particular gadget.

Parameters:
nIndex - - index of the gadget
Returns:
int - topic pos

GetSuppressTitleBar

boolean GetSuppressTitleBar(int nIndex)
Get whether the gadget at a particular index is has a suppressed title bar or not.

Parameters:
nIndex - - index of the gadget
Returns:
boolean - suppressed or shown

GetHasHelpURL

boolean GetHasHelpURL(int nIndex)
Get whether the gadget at a particular index has a help URL or not.

Parameters:
nIndex - - index of the gadget
Returns:
boolean - has help url or not

GetDisabledMessage

java.lang.String GetDisabledMessage(int nIndex)
Get the disabled message for a gadget at a particular index.

Parameters:
nIndex - - index of the gadget
Returns:
String - disabled message string

GetSupportsUserInterface

boolean GetSupportsUserInterface(int nIndex)
Get whether or not the gadget at a particular index supports non-standard user interfaces.

Parameters:
nIndex - - index of the gadget
Returns:
boolean - supports or doesn't support

GetSupportsPersonalization

int GetSupportsPersonalization(int nIndex)
Get the gadget at a particular index's personalization value, which can then be bitmasked with to a type in PT_GADGETPERSONALIZATION_ROLES.

Parameters:
nIndex - - index of the gadget
Returns:
int - personalization value

GetHasRefreshButton

boolean GetHasRefreshButton(int nIndex)
Get whether the portlet at a particular index has a refresh button or not.

Parameters:
nIndex - - index of the portlet
Returns:
boolean - has refresh button or not

GetGadgetUUID

java.lang.String GetGadgetUUID(int nIndex)
Get the UUID of the portlet.

Parameters:
nIndex - - index of the portlet
Returns:
String - UUID of the portlet

GetCollapsedOrErrorContent

java.lang.Object[][] GetCollapsedOrErrorContent(int iIndex)
Gets the content that should be displayed for this portlet if it's in a collapsed or error state. Usually this is Javascript.

Parameters:
iIndex - - index of the portlet
Returns:
Object[][] - content markup for the gadget


Copyright 2008 Plumtree Software Inc. All Rights Reserved.