|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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)
IPTGdagetInfo,
IPTGdagetGateway,
IPTGdagetCacheSite,
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 |
| Method Detail |
public void Initialize(java.lang.String bstrGadgetProviderCLSID)
bstrGadgetProviderCLSID - string gadget type classificationpublic java.lang.String GetGadgetBrowserCLSID()
public java.lang.String GetGadgetProviderCLSID()
public com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
public void SetProviderInfo(java.lang.Object Value)
Value - Object downcast of IPropertyBag for provider
datapublic java.lang.Object[][] GetHTMLText(java.lang.Object vAppDataStateObject)
vAppDataStateObject - Single object app data statePT_MARKUP_ARRAY_COLS,
IPTStatepublic int GetAlignment()
PT_GADGET_ALIGNMENTSpublic void SetAlignment(int Value)
Value - intPT_GADGET_ALIGNMENTSpublic int GetGadgetType()
PT_GADGET_TYPESpublic void SetGadgetType(int Value)
Value - intpublic int GetMandatoryGadgetOrder()
PT_MANDATORYORDERINGpublic void SetMandatoryGadgetOrder(int Value)
Value - intPT_MANDATORYORDERINGpublic IPTQueryResult QueryMandatoryGroups()
IPTQueryResultpublic void AddMandatoryGroup(int lGroupID)
lGroupID - public void RemoveMandatoryGroup(int lGroupID)
lGroupID - public int GetGadgetTemplateID()
public void SetGadgetTemplateID(int Value)
Value - intpublic int GetWebServiceID()
public void SetWebServiceID(int Value)
Value - intpublic boolean GetSuppressTitleBar()
public void SetSuppressTitleBar(boolean Value)
Value - boolean
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||