com.plumtree.server
Interface IPTGadget

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown
All Known Subinterfaces:
IPTGadgetTemplate

public interface IPTGadget
extends IPTObject

The Gadget interface wraps access to a specific portlet instance. This allows you to query the HTML content of a portlet, get and set properties, import and export, execute a job operation (in this case write HTML to the disk).

Author:
DavidP
See Also:
IPTGdagetInfo, IPTGadgetGateway, IPTGadgetCacheSite, IPTWebService, IPTQueryResult, IPTState, PT_MARKUP_ARRAY_COLS, PT_MANDATORYORDERING, PT_GADGET_TYPES

Method Summary
 void AddMandatoryGroup(int lGroupID)
          Adds this gadget as mandatory to the specified group
 int GetAlignment()
          Gadget alignment refers to the column the gadget is in within the specific page layout.
 java.lang.String GetGadgetBrowserCLSID()
          Obsolete.
 java.lang.String GetGadgetProviderCLSID()
          Retrieves the CLSID of the gadget provider (for example, the remote gadget provider, or intrinsic gadget provider)
 int GetGadgetTemplateID()
          Retrieves the template ID of this gadget Note: This value is only set if the gadget was instantiated from a gadget template, or if this gadget is of type template
 int GetGadgetType()
          Gadget types refer to personal, community, and template (gadget template).
 java.lang.Object[][] GetHTMLText(java.lang.Object vAppDataStateObject)
          Retrieves the HTML text from the portlet
 int GetMandatoryGadgetOrder()
          Retrieves the "priority" of this gadget if it is mandatory.
 com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
          Gets the property bag containing all properties for the associated gadget provider
 boolean GetSuppressTitleBar()
          Returns true if the title bar is supressed for this gadget.
 int GetWebServiceID()
          Retrieves the web service ID for this gadget.
 void Initialize(java.lang.String bstrGadgetProviderCLSID)
          Initializes the portlet instance using a CLSID to specify gadget type.
 IPTQueryResult QueryMandatoryGroups()
          Queries for the list of groups this gadget is mandatory on
 void RemoveMandatoryGroup(int lGroupID)
          Removes this gadget as a mandatory for the specified group
 void SetAlignment(int Value)
          Sets the gadget alignment (column number).
 void SetGadgetTemplateID(int Value)
          Sets the gadget template ID.
 void SetGadgetType(int Value)
          Sets the gadget type.
 void SetMandatoryGadgetOrder(int Value)
          Sets the mandatory order.
 void SetProviderInfo(java.lang.Object Value)
          Sets the gadget provider properties
 void SetSuppressTitleBar(boolean Value)
          If you set this to true, the titlebar on the gadget will be supressed when it is displayed.
 void SetWebServiceID(int Value)
          Sets the wbe service ID.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

Initialize

void Initialize(java.lang.String bstrGadgetProviderCLSID)
Initializes the portlet instance using a CLSID to specify gadget type.

Parameters:
bstrGadgetProviderCLSID - string gadget type classification

GetGadgetBrowserCLSID

java.lang.String GetGadgetBrowserCLSID()
Obsolete. Used in Plumtree 3.X for the standalone Windows client version fo the administration server.

Returns:
String containing CLSID

GetGadgetProviderCLSID

java.lang.String GetGadgetProviderCLSID()
Retrieves the CLSID of the gadget provider (for example, the remote gadget provider, or intrinsic gadget provider)

Returns:
String containing CLSID

GetProviderInfo

com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
Gets the property bag containing all properties for the associated gadget provider

Returns:
IXPPropertyBag

SetProviderInfo

void SetProviderInfo(java.lang.Object Value)
Sets the gadget provider properties

Parameters:
Value - Object downcast of IPropertyBag for provider data

GetHTMLText

java.lang.Object[][] GetHTMLText(java.lang.Object vAppDataStateObject)
Retrieves the HTML text from the portlet

Parameters:
vAppDataStateObject - Single object app data state
Returns:
2D array of HTML markup fragments for assembly; 1st index is markup column, 2nd index is fragment
See Also:
PT_MARKUP_ARRAY_COLS, IPTState

GetAlignment

int GetAlignment()
Gadget alignment refers to the column the gadget is in within the specific page layout. 0 is column zero, 1 is column 1, and so on. The maximum, at this time, is 2, only achievable in the narrow-wide-narrow page layout.

Returns:
int
See Also:
PT_GADGET_ALIGNMENTS

SetAlignment

void SetAlignment(int Value)
Sets the gadget alignment (column number). See GetAlignment().

Parameters:
Value - int
See Also:
PT_GADGET_ALIGNMENTS

GetGadgetType

int GetGadgetType()
Gadget types refer to personal, community, and template (gadget template). The "panel" type is not supported.

Returns:
int
See Also:
PT_GADGET_TYPES

SetGadgetType

void SetGadgetType(int Value)
Sets the gadget type. See GetGadgetType().

Parameters:
Value - int

GetMandatoryGadgetOrder

int GetMandatoryGadgetOrder()
Retrieves the "priority" of this gadget if it is mandatory. Used to determine vertical order of mandatory gadgets.

Returns:
int
See Also:
PT_MANDATORYORDERING

SetMandatoryGadgetOrder

void SetMandatoryGadgetOrder(int Value)
Sets the mandatory order. See GetMandatoryGadgetOrder().

Parameters:
Value - int
See Also:
PT_MANDATORYORDERING

QueryMandatoryGroups

IPTQueryResult QueryMandatoryGroups()
Queries for the list of groups this gadget is mandatory on

Returns:
IPTQueryResult
See Also:
IPTQueryResult

AddMandatoryGroup

void AddMandatoryGroup(int lGroupID)
Adds this gadget as mandatory to the specified group

Parameters:
lGroupID -

RemoveMandatoryGroup

void RemoveMandatoryGroup(int lGroupID)
Removes this gadget as a mandatory for the specified group

Parameters:
lGroupID -

GetGadgetTemplateID

int GetGadgetTemplateID()
Retrieves the template ID of this gadget Note: This value is only set if the gadget was instantiated from a gadget template, or if this gadget is of type template

Returns:
int

SetGadgetTemplateID

void SetGadgetTemplateID(int Value)
Sets the gadget template ID. See GetGadgetTemplateID();

Parameters:
Value - int

GetWebServiceID

int GetWebServiceID()
Retrieves the web service ID for this gadget. If this is an intrinsic gadget no web service is required.

Returns:
int

SetWebServiceID

void SetWebServiceID(int Value)
Sets the wbe service ID. See GetWebServiceID().

Parameters:
Value - int

GetSuppressTitleBar

boolean GetSuppressTitleBar()
Returns true if the title bar is supressed for this gadget.

Returns:
boolean

SetSuppressTitleBar

void SetSuppressTitleBar(boolean Value)
If you set this to true, the titlebar on the gadget will be supressed when it is displayed.

Parameters:
Value - boolean


Copyright 2008 Plumtree Software Inc. All Rights Reserved.