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 IContextDependent

All Known Implementing Classes:
AbstractButtonTableWidget, AbstractButtonWidget, AbstractCheckboxWidget, AbstractInputWidget, AbstractLinkWidget, BasicButtonWidget, BasicCheckboxWidget, BasicDialogWidget, BasicLinkWidget, BasicSLRadioButtonWidget, ButtonTableWidget, ButtonWidget, CalendarWidget, CheckboxWidget, CommandLineComponent, DialogComponent, DialogWidget, DropdownWidget, EnptuiScrollbarComponent, EnptuiScrollbarWidget, EnptuiSelectionFieldComponent, EnptuiWindowComponent, FieldComponent, FieldWidget, FunctionKeyComponent, HtmlDDSComponent, InputComponent, InputWidget, InputWithHintsComponent, ISRadioButtonWidget, ItemSelectionComponent, ItemSelectionLinkWidget, LinkWidget, ListWidget, PopupWidget, RadioButtonWidget, SelectionListComponent, SelectorPenAttentionComponent, SelectorPenComponent, SelectorPenSelectionComponent, SLDropdownWidget, SLRadioButtonWidget, SubfileCheckboxWidget, SubfilePopupWidget, SubfileWidgetV6, TextComponent, URLComponent

public interface IContextDependent

IContextDependent is an interface which allows Components or Widgets to programatically exclude themselves or their settings from view in the studio. Implementing classes must evaluate the context attributes to determine if they should be shown, or given a property name, evaluate the context attributes to determine if that property should be displayed.

See Also:
TransformationConstants

Field Summary
static String COPYRIGHT
          The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
 
Method Summary
 boolean isAllowed(ContextAttributes contextAttributes)
          Gets whether or not this object should be visible in the studio given some context attributes.
 boolean isPropertyAllowed(String name, ContextAttributes contextAttributes)
          Gets whether or not the specified property should be visible in the component or widget settings.
 

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
Method Detail

isAllowed

boolean isAllowed(ContextAttributes contextAttributes)
Gets whether or not this object should be visible in the studio given some context attributes. The context attributes may contain the Component name when this is called on a Widget, or whether or not we are presenting this Component/Widget choice while configuring Default Rendering.

Parameters:
contextAttributes -
Returns:
whether or not this Component or Widget is allowed in the specified context

isPropertyAllowed

boolean isPropertyAllowed(String name,
                          ContextAttributes contextAttributes)
Gets whether or not the specified property should be visible in the component or widget settings. The context attributes may contain the Component name when this is called on a Widget, or whether or not we are presenting this Component/Widget choice while configuring Default Rendering.

Parameters:
name - property name
contextAttributes -
Returns:
whether or not this property is allowed in the specified context

HATS 7.5.1 (201005110649)