WebCenter Interaction API  
 

IPTGadget Members

IPTGadget overview

Public Instance Methods

public methodAddMandatoryGroup Adds this gadget as mandatory to the specified group
public methodGetAlignment 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.
public methodGetGadgetBrowserCLSID Obsolete. Used in Plumtree 3.X for the standalone Windows client version fo the administration server.
public methodGetGadgetProviderCLSID Retrieves the CLSID of the gadget provider (for example, the remote gadget provider, or intrinsic gadget provider)
public methodGetGadgetTemplateID 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
public methodGetGadgetType Gadget types refer to personal, community, and template (gadget template). The "panel" type is not supported.
public methodGetHTMLText Retrieves the HTML text from the portlet
public methodGetMandatoryGadgetOrder Retrieves the "priority" of this gadget if it is mandatory. Used to determine vertical order of mandatory gadgets.
public methodGetProviderInfo Gets the property bag containing all properties for the associated gadget provider
public methodGetSuppressTitleBar Returns true if the title bar is supressed for this gadget.
public methodGetWebServiceID Retrieves the web service ID for this gadget. If this is an intrinsic gadget no web service is required.
public methodInitialize Initializes the portlet instance using a CLSID to specify gadget type.
public methodQueryMandatoryGroups Queries for the list of groups this gadget is mandatory on
public methodRemoveMandatoryGroup Removes this gadget as a mandatory for the specified group
public methodSetAlignment Sets the gadget alignment (column number). See GetAlignment().
public methodSetGadgetTemplateID Sets the gadget template ID. See GetGadgetTemplateID();
public methodSetGadgetType Sets the gadget type. See GetGadgetType().
public methodSetMandatoryGadgetOrder Sets the mandatory order. See GetMandatoryGadgetOrder().
public methodSetProviderInfo Sets the gadget provider properties
public methodSetSuppressTitleBar If you set this to true, the titlebar on the gadget will be supressed when it is displayed.
public methodSetWebServiceID Sets the wbe service ID. See GetWebServiceID().

See Also

IPTGadget Interface | com.plumtree.server Namespace | IPTGdagetInfo | IPTGadgetGateway | IPTGadgetCacheSite | IPTWebService | IPTQueryResult | IPTState | PT_MARKUP_ARRAY_COLS | PT_MANDATORYORDERING | PT_GADGET_TYPES