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.transform.widgets
Class AbstractCheckboxWidget

java.lang.Object
  extended by com.ibm.hats.transform.widgets.Widget
      extended by com.ibm.hats.transform.widgets.AbstractCheckboxWidget
All Implemented Interfaces:
IContextDependent, ICustomPropertySupplier, com.ibm.hats.transform.renderers.TextRenderer
Direct Known Subclasses:
BasicCheckboxWidget

public class AbstractCheckboxWidget
extends Widget
implements IContextDependent


Field Summary
protected  String deselectValue
           
static String PROPERTY_DESELECT_VALUE
           
static String PROPERTY_SELECT_VALUE
           
protected  String selectValue
           
 
Fields inherited from class com.ibm.hats.transform.widgets.Widget
CLASS_NAME, componentElements, contextAttributes, settings
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
AbstractCheckboxWidget(ComponentElement[] componentElements, Properties settings)
           
 
Method Summary
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
 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.
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomProperties, getCustomPropertiesBiDi, getDefaultValues, getSettings, insertAlign, insertDir, newInstance, setComponentElements, setContextAttribute, setContextAttributes, setSettings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_SELECT_VALUE

public static final String PROPERTY_SELECT_VALUE
See Also:
Constant Field Values

PROPERTY_DESELECT_VALUE

public static final String PROPERTY_DESELECT_VALUE
See Also:
Constant Field Values

selectValue

protected String selectValue

deselectValue

protected String deselectValue
Constructor Detail

AbstractCheckboxWidget

public AbstractCheckboxWidget(ComponentElement[] componentElements,
                              Properties settings)
Parameters:
componentElements -
settings -
Method Detail

getPropertyPageCount

public int getPropertyPageCount()
Description copied from interface: ICustomPropertySupplier
Returns the number of property pages associated with this object.

Note: Currently only 0 or 1 pages are supported.

Specified by:
getPropertyPageCount in interface ICustomPropertySupplier
Overrides:
getPropertyPageCount in class Widget
Returns:
the number of defined property pages used to configure this object, or 0 if there are none

isAllowed

public boolean isAllowed(ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
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.

Specified by:
isAllowed in interface IContextDependent
Returns:
whether or not this Component or Widget is allowed in the specified context

isPropertyAllowed

public boolean isPropertyAllowed(String name,
                                 ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
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.

Specified by:
isPropertyAllowed in interface IContextDependent
Parameters:
name - property name
Returns:
whether or not this property is allowed in the specified context

HATS 7.5.1 (201005110649)