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 AbstractInputWidget

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

public class AbstractInputWidget
extends Widget
implements IContextDependent


Field Summary
static String PROPERTY_CAPTION
           
static String PROPERTY_CAPTION_SOURCE
           
static String PROPERTY_COLUMNS_PER_ROW
           
static String PROPERTY_ELIMINATE_MAX_LENGTH
           
static String PROPERTY_ENABLE_CHECK_ATTRIBUTES
           
static String PROPERTY_ENABLE_INPUT_RESTRICTIONS
           
static String PROPERTY_ENABLE_NUMERIC_LOCK
           
static String PROPERTY_MAXLEN
           
static String PROPERTY_OVERRIDE_MAXLEN
           
static String PROPERTY_OVERRIDE_SIZE
           
static String PROPERTY_READ_ONLY
           
static String PROPERTY_SIZE
           
static String PROPERTY_STRIP_UNDERLINES_ON_INPUTS
           
static String PROPERTY_TRIM_SPACES_ON_INPUTS
           
static String SOURCE_COMPONENT
           
static String SOURCE_VALUE
           
 
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
AbstractInputWidget(ComponentElement[] componentElements, Properties settings)
           
 
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.
 
Methods inherited from class com.ibm.hats.transform.widgets.Widget
convertBidi, draw, getComponentElements, getContextAttribute, getContextAttributes, getCustomComposite, getCustomProperties, getCustomPropertiesBiDi, getDefaultValues, getPropertyPageCount, 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_OVERRIDE_SIZE

public static final String PROPERTY_OVERRIDE_SIZE
See Also:
Constant Field Values

PROPERTY_SIZE

public static final String PROPERTY_SIZE
See Also:
Constant Field Values

PROPERTY_OVERRIDE_MAXLEN

public static final String PROPERTY_OVERRIDE_MAXLEN
See Also:
Constant Field Values

PROPERTY_MAXLEN

public static final String PROPERTY_MAXLEN
See Also:
Constant Field Values

PROPERTY_COLUMNS_PER_ROW

public static final String PROPERTY_COLUMNS_PER_ROW
See Also:
Constant Field Values

PROPERTY_CAPTION_SOURCE

public static final String PROPERTY_CAPTION_SOURCE
See Also:
Constant Field Values

PROPERTY_CAPTION

public static final String PROPERTY_CAPTION
See Also:
Constant Field Values

PROPERTY_ENABLE_INPUT_RESTRICTIONS

public static final String PROPERTY_ENABLE_INPUT_RESTRICTIONS
See Also:
Constant Field Values

PROPERTY_ENABLE_CHECK_ATTRIBUTES

public static final String PROPERTY_ENABLE_CHECK_ATTRIBUTES
See Also:
Constant Field Values

PROPERTY_ENABLE_NUMERIC_LOCK

public static final String PROPERTY_ENABLE_NUMERIC_LOCK
See Also:
Constant Field Values

PROPERTY_STRIP_UNDERLINES_ON_INPUTS

public static final String PROPERTY_STRIP_UNDERLINES_ON_INPUTS
See Also:
Constant Field Values

PROPERTY_TRIM_SPACES_ON_INPUTS

public static final String PROPERTY_TRIM_SPACES_ON_INPUTS
See Also:
Constant Field Values

PROPERTY_ELIMINATE_MAX_LENGTH

public static final String PROPERTY_ELIMINATE_MAX_LENGTH
See Also:
Constant Field Values

PROPERTY_READ_ONLY

public static final String PROPERTY_READ_ONLY
See Also:
Constant Field Values

SOURCE_COMPONENT

public static final String SOURCE_COMPONENT
See Also:
Constant Field Values

SOURCE_VALUE

public static final String SOURCE_VALUE
See Also:
Constant Field Values
Constructor Detail

AbstractInputWidget

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

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)