Skip navigation links

oracle.adf.view.rich.model
Class BaseAttributeDescriptor

java.lang.Object
oracle.adf.view.rich.model.Descriptor
oracle.adf.view.rich.model.BaseAttributeDescriptor

Direct Known Subclasses:

AttributeDescriptor

public abstract class BaseAttributeDescriptor

extends Descriptor

A BaseAttributeDescriptor represents an attribute that is part of a view object (in ADF) or any other model object.

Field Summary

static java.lang.String

DESCRIPTOR_TYPE_ATTRIBUTE

Fields inherited from class oracle.adf.view.rich.model.Descriptor

DESCRIPTOR_TYPE_DEFAULT

Constructor Summary

BaseAttributeDescriptor()

Method Summary

abstract AttributeDescriptor.ComponentType	getComponentType() Returns the component to use to render the value part of the search field.
javax.faces.convert.Converter	getConverter() Returns a converter instance to use with this Attribute.
java.lang.String	getDescriptorType() Returns "ATTRIBUTE" as descriptor type of this object.
java.lang.String	getFormat() Returns a format to use when showing a locale specific value for this attribute.
java.lang.String	getGroupName() Returns the group name that this attribute belongs to.
abstract int	getLength() Returns the size of the text control specified by the number of characters shown.
abstract int	getMaximumLength() Returns the the maximum number of characters per line that can be entered into the text control.
abstract java.lang.Object	getModel() Returns the model object that represents the data for the component.
java.lang.String	getPlaceholder() Returns the placeholder text for the attribute
java.util.TimeZone	getTimeZone() Returns a TimeZone to be set on the DateTimeConverter associated with this Attribute.
abstract java.lang.Class	getType() Returns the data type of the attribute.
javax.faces.validator.Validator	getValidator() Returns a Validator instance to use with this Attribute.
boolean	hasDefaultConverter() Returns a boolean to specify whether there is a default converter based on the data type This default converter will be created and attached to the component.
abstract boolean	isReadOnly() Whether the attribute is readOnly.
abstract boolean	isRequired() Whether the attribute is required or not.

Methods inherited from class oracle.adf.view.rich.model.Descriptor

getDescription, getLabel, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DESCRIPTOR_TYPE_ATTRIBUTE

public static final java.lang.String DESCRIPTOR_TYPE_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

BaseAttributeDescriptor

public BaseAttributeDescriptor()

Method Detail

getComponentType

public abstract AttributeDescriptor.ComponentType getComponentType()

Returns the component to use to render the value part of the search field. When the attribute has no component type associated with it, then the component to use is determined by its type.

Returns:

a ComponentType enum.

getFormat

public java.lang.String getFormat()

Returns a format to use when showing a locale specific value for this attribute.
For e.g., this could be a pattern like mm/dd/yyyy to use when converting the value. The format pattern used depends on the dataType of the attribute.

Returns:

an Object.

getConverter

public javax.faces.convert.Converter getConverter()

Returns a converter instance to use with this Attribute.

Returns:

an Converter Object.

getTimeZone

public java.util.TimeZone getTimeZone()

Returns a TimeZone to be set on the DateTimeConverter associated with this Attribute.

Returns:

an TimeZone Object.

getValidator

public javax.faces.validator.Validator getValidator()

Returns a Validator instance to use with this Attribute.

Returns:

a Validator Object.

getLength

public abstract int getLength()

Returns the size of the text control specified by the number of characters shown. The length is estimated based on the default font size of the browser.

getMaximumLength

public abstract int getMaximumLength()

Returns the the maximum number of characters per line that can be entered into the text control. This includes the characters representing the new line. If set to 0 or less, the maximumLength is ignored.

getModel

public abstract java.lang.Object getModel()

Returns the model object that represents the data for the component.

• For inputListOfValues/inputComboboxListOfValues, it's a ListOfValuesModel
• For inputNumberSpinbox, it's a NumberRange object
• For selectXyz components, it must be List<SelectItem>
• Undefined for other types

getDescriptorType

public java.lang.String getDescriptorType()

Returns "ATTRIBUTE" as descriptor type of this object. This is used to differentiate descriptor objects as either Attributes or AttributeGroup.

Overrides:

getDescriptorType in class Descriptor

Returns:

String

getGroupName

public java.lang.String getGroupName()

Returns the group name that this attribute belongs to.

Returns:

String groupName

getType

public abstract java.lang.Class getType()

Returns the data type of the attribute. It is used to determine the type of component and the converter to use when rendering its value.

Returns:

a valid java.lang.Class instance

isReadOnly

public abstract boolean isReadOnly()

Whether the attribute is readOnly. A true value indicates that a value cannot be entered for this attribute.

Returns:

a boolean.

isRequired

public abstract boolean isRequired()

Whether the attribute is required or not.

Returns:

a boolean false.

getPlaceholder

public java.lang.String getPlaceholder()

Returns the placeholder text for the attribute

Returns:

String placeholder text

hasDefaultConverter

public boolean hasDefaultConverter()

Returns a boolean to specify whether there is a default converter based on the data type This default converter will be created and attached to the component. If the getConverter() method however returns a converter, it will be attached to the component irrespective of this API.

Returns:

a boolean

Skip navigation links