com.plumtree.server
Interface IPTMyPortalGadgetContent

All Superinterfaces:
IPTUnknown

public interface IPTMyPortalGadgetContent
extends IPTUnknown

IPTMyPortalGadgetContent


Method Summary
 int Find(int nGadgetID)
          Find the index of a gadget using a gadget id.
 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.
 boolean GetHasHelpURL(int nIndex)
          Get whether the gadget at a particular index has a help URL or not.
 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

public int GetCount()
Get the number of gadgets represented by this object.
Returns:
int - number of gadgets

Find

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.