HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.common
Interface ICustomPropertySupplier

All Known Implementing Classes:
AbstractButtonTableWidget, AbstractButtonWidget, AbstractCheckboxWidget, AbstractFieldWidget, AbstractInputWidget, AbstractLinkWidget, AbstractRadioButtonWidget, AbstractSubfileWidget, AbstractTableComponent, AbstractTableWidget, AllInputFieldsPatternComponent, BasicButtonWidget, BasicCheckboxWidget, BasicDialogWidget, BasicLinkWidget, BasicSLRadioButtonWidget, ButtonTableWidget, ButtonWidget, CalendarWidget, CheckboxWidget, CommandLineComponent, Component, DefaultRenderingEngine, DialogComponent, DialogWidget, DropdownWidget, EnptuiScrollbarComponent, EnptuiScrollbarWidget, EnptuiSelectionFieldComponent, EnptuiWindowComponent, FieldComponent, FieldTableComponent, FieldWidget, FunctionKeyComponent, GraphWidget, HorizontalBarGraphWidget, HtmlDDSComponent, InputComponent, InputFieldByPositionPatternComponent, InputFieldBySizePatternComponent, InputFieldByTextPatternComponent, InputWidget, InputWithHintsComponent, ISRadioButtonWidget, ItemSelectionComponent, ItemSelectionLinkWidget, LabelWidget, LineGraphWidget, LinkWidget, ListWidget, PatternComponent, PopupWidget, RadioButtonWidget, SelectionListComponent, SelectorPenAttentionComponent, SelectorPenComponent, SelectorPenSelectionComponent, SLDropdownWidget, SLRadioButtonWidget, SubfileCheckboxWidget, SubfileComponentV6, SubfilePopupWidget, SubfileWidget, SubfileWidgetV6, TableComponent, TableHeaderComponent, TableWidget, TextComponent, URLComponent, VerticalBarGraphWidget, VisualTableComponent, Widget

public interface ICustomPropertySupplier

Interface to provide information about user customizable settings for an object, along with the details on how to display them so they can be configured.

See Also:
HCustomProperty

Field Summary
static String CLASSNAME
           
static String COPYRIGHT
          The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
 
Method Summary
 Class getCustomComposite()
          Returns a Class object (assignable from com.ibm.hats.studio.composites.BasePropertiesComposite) if a custom composite is to be used to represent the customizable properties for this object or null if dynamic GUI is to be used.
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 Properties getDefaultValues(int iPageNumber)
          Returns this object's default property values.
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
 

Field Detail

COPYRIGHT

static final String COPYRIGHT
The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values

CLASSNAME

static final String CLASSNAME
See Also:
Constant Field Values
Method Detail

getPropertyPageCount

int getPropertyPageCount()
Returns the number of property pages associated with this object.

Note: Currently only 0 or 1 pages are supported.

Returns:
the number of defined property pages used to configure this object, or 0 if there are none

getCustomProperties

Vector getCustomProperties(int iPageNumber,
                           Properties properties,
                           ResourceBundle bundle)
Returns a list of this object's custom properties. Items must be of type com.ibm.hats.common.HCustomProperty.

Parameters:
iPageNumber - page number containing desired properties
properties - existing values for properties defined here
bundle - ResourceBundle containing NLS descriptions for the properties
Returns:
Vector containing all the custom properties for this object, or null if there are none
See Also:
HCustomProperty

getCustomComposite

Class getCustomComposite()
Returns a Class object (assignable from com.ibm.hats.studio.composites.BasePropertiesComposite) if a custom composite is to be used to represent the customizable properties for this object or null if dynamic GUI is to be used. Note: this function only applies to HATS Studio

Returns:
custom composite (of type BasePropertiesComposite) or null if dynamic GUI should be used
See Also:
BasePropertiesComposite

getDefaultValues

Properties getDefaultValues(int iPageNumber)
Returns this object's default property values.

Parameters:
iPageNumber - page for which to retrieve default properties
Returns:
object's default properties

HATS 7.5.1 (201005110649)