JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.js.component
Class AdfUIComponent

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.component.AdfUIComponent

public class AdfUIComponent
extends AdfObject

AdfUIComponent base class

Field Summary

private static Object	_ACCESSOR_CACHE
private static Object	_ACCESSOR_NAME_CACHE
private static Object	_ADD_LISTENER_CACHE
private static Object	_ADD_LISTENER_NAME_CACHE
private static Object	_BEHAVIORS_KEY
private static Object	_CLASS_PROPERTY_KEYS Name of property containing the list of property keys for this class
private Object	_clientId
private static Object	_COMPONENT_FACTORY
private static Object	_CONSTANT_CACHE
private static Object	_DEFAULT_VALUE_UNDEFINED
private static Object	_FLAG_PERSISTENCE
private static Object	_MUTATOR_CACHE
private static Object	_MUTATOR_NAME_CACHE
private Object	_props
private static Object	_REMOVE_LISTENER_CACHE
private static Object	_REMOVE_LISTENER_NAME_CACHE
public static Object	STATE_COMPLETE UIComponent state indicating that all of the component's state is available
public static Object	STATE_LOADING UICOmponent state indicating that the component is still loading state or content
public static Object	USAGE_PRIVATE_CHILD This component is a private implementation detail of one of its ancestors

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfUIComponent(Object componentType) AdfUIComponent base class

Method Summary

public Object	addEventListener(Object eventType, Object listener, Object instance) Adds a listener function of the specifed listener type.
protected Object	AddNotify()
public Object	broadcast(Object event) Broadcasts the specified event on the component to the component's listeners
private Object	_bubbleEvent(Object event)
public Object	clearChanges()
public Object	clone() Override to create new storage.
protected Object	ComparePropertyValues(Object propName, Object oldValue, Object newValue) Compares the old value and the new value for a property and returns TRUE if they are equal.
private static Object	_createAccessorName(Object propertyName) Given the name of a property, returns the name of the accessor convenience for that property.
public static Object	createComponent(Object componentType) Creates a AdfUIComponent instance of the class with the closest match to the specified component type
private static Object	_createMutatorName(Object propertyName, Object constantName) Given the name of a property, returns the name of the mutator convenience for that property.
protected Object	DeliverDerivedPropertyEvents(Object propName, Object oldValue, Object newValue) Hook for subclasses to deliver events derived from property change events
private Object	_deliverEvent(Object event) protected handling of the event
private Object	_deliverEventToListener(AdfBaseEvent event, Object instance, Function listener) Delivers an event, either to a function or an AdfClientListener
private Object	_deliverEventToListeners(AdfBaseEvent event, Object listeners) Delivers an event, either to a function or an AdfClientListener
private static Object	_findAbsoluteComponent(Object searchScopedId) Find a component using an absolute scoped id
public AdfUIComponent	findComponent(String expr, Boolean skipDeprecation) Search for and return the AdfUIComponent with an id that matches the specified search expression.
static Object	__findComponent(Object expr, Object component, Object skipDeprecation)
public AdfUIComponent	findComponentByLocator(String locator) Search for and return the AdfUIComponent with locator that matches the specified absolute locator expression.
static AdfUIComponent	__findComponentByLocator(String locator, Object component) Search for and return the AdfUIComponent with locator that matches the specified absolute locator expression.
private static Object	_findRelativeComponent(Object clientId, Object isNamingContainer, Object ncCount, Object searchClientId, Object separator, Object expr, Object skipDeprecation)
public Object	focus()
public String	getAbsoluteId() Returns the absolute scoped id for this component without the leading ":".
public String	getAbsoluteLocator() Returns the absolute locator, an implementation-agnostic String identifier.
public String	getAccessibleName() Returns the localized String that represents the purpose of this Object.
protected Object	GetChanges()
public Object	getClientId() Returns the client-specific ID for this component generated by the Server.
private Object	_getClientListeners()
public Object	getComponentType()
public Object	getDescendantComponents(Array<AdfUIComponent> children) Get components descended from this component.
public Object	getDragSource() Returns the AdfDragSource associated with this component.
public Object	getDropTarget() Returns the AdfDropTarget associated with this component.
public String	getInlineStyleProperty(String propName) returns the style values corresponding to the CSS propertyName.
public Object	getParent()
public Object	getPeer()
public Object	getProperty(Object propName) Returns the raw value of a property.
public Object	getPropertyKeys() Returns the array of the keys of all properties available on this Component
public Object	getPropertyValue(Object propName) Returns the evaluated value of a property.
public Object	getReadyState() Returns whether the UIComponent is ready.
protected static Object	GetSubclassPropertyKeys()
protected Object	HandleBubbledEvent(Object event) Protected handling of a bubbled event
protected Object	HandleEvent(Object event) Protected default handling of an event.
protected Object	Init(Object componentType, Object clientId, Object properties, Object usageFlags) Initialize this component instance
private static Object	_initAccessors(Object ourClass, Object propertyNames, Object constantSuffix, Object accessorPrefix, Object mutatorPrefix)
private Object	_initBehaviors(Object behaviors)
protected static Object	InitClass() Initialize the constants of the AdfUIComponent class flatten the lists of propertyKeys and events Create the accessors and mutators for the lists.
public Object	initializeProperty(String propName, Object newValue) This method can be used to initialize an undefined property.
public Object	isDescendant(Object possibleAncestor) Returns true if this AdfUIComponent is a descendant of the possibleAncestor
public Object	isEventRoot() Identifies if the component is an event root.
static Object	__isNamingContainer(Object constructor)
public Object	isShowing() Returns true if the component is visible to the user
private static Object	_matchAbsoluteIdCallback(Object component) Callback called from AdfUIComponent._findAbsoluteComponent to match components
public Boolean	processPushData(Object payload, Number changeCount) Called by the Active Data Service to deliver push data to the component.
public Object	queueEvent(Object event) Queues an event for delivery to this component.
public static Object	registerComponent(Object componentType, Object componentClass) Registers a mapping between the specified component type and the constructor of the AdfUIComponent subclass to instantiate in response to calls to AdfUIComponent.createComponent.
public Object	removeEventListener(Object eventType, Object listener, Object instance) Removes a listener function of the specifed listener type.
protected Object	RemoveNotify()
private static Object	_removePersistedFlag(Object propertyName) Given the name of the property, strips of the persisted flag if present
public Object	resizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight) Notification method called when browser window resize occurs.
public Object	satisfiesUsage(Object usage)
public Object	scrollIntoView(Boolean focus, String subTargetId) Scrolls this component into view.
protected static Object	SetDisconnectedProperty(Object componentClass, Object propName) Add protected utility method to set a property as disconnected
public Object	setDragSource(Object dragSource) Sets the AdfDragSource associated with this component.
public Object	setDropTarget(Object dropTarget) Sets the AdfDropTarget associated with this component.
public Object	setInlineStyleProperty(String propName, String propValue) Sets the value for a given css style property.
static Object	__setNamingContainer(Object constructor, Object isNC)
Object	__setParent(Object newParent)
public Object	setProperty(String propName, Object newValue, Object persist, Number propagate) Sets a property on the component to a new value, firing a PropertyChangeEvent if the property's value has changed.
protected Object	SetPropertyImpl(Object propName, Object oldValue, Object newValue) Subclass property change hook
private static Object	_setPropertyInfo(Function componentClass, String propName, String metadataProp, Object metadataValue) Private utility method to change the property type metadata.
protected static Object	SetPropertyType(Function componentClass, String propName, String typeName) Protected utility method to change the default type of a proeprty.
private Object	_setSource(Object source)
public Object	toDebugString() Override to ditch "Object" and add the component type
private static Object	_trimAbsoluteScopedId(Object absoluteScopedId, Object trimCount) Trim an absolute scoped id of the correct number of trailing sections including a trailing ":"
public Number	visitChildren(Function callback, Object context, Boolean ignoreHidden) Visits all of the children components of the component.

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toString

Field Detail

_ACCESSOR_CACHE

private static Object _ACCESSOR_CACHE

_ACCESSOR_NAME_CACHE

private static Object _ACCESSOR_NAME_CACHE

_ADD_LISTENER_CACHE

private static Object _ADD_LISTENER_CACHE

_ADD_LISTENER_NAME_CACHE

private static Object _ADD_LISTENER_NAME_CACHE

_BEHAVIORS_KEY

private static Object _BEHAVIORS_KEY

_CLASS_PROPERTY_KEYS

private static Object _CLASS_PROPERTY_KEYS

Name of property containing the list of property keys for this class

_clientId

private Object _clientId

_COMPONENT_FACTORY

private static Object _COMPONENT_FACTORY

_CONSTANT_CACHE

private static Object _CONSTANT_CACHE

_DEFAULT_VALUE_UNDEFINED

private static Object _DEFAULT_VALUE_UNDEFINED

_FLAG_PERSISTENCE

private static Object _FLAG_PERSISTENCE

_MUTATOR_CACHE

private static Object _MUTATOR_CACHE

_MUTATOR_NAME_CACHE

private static Object _MUTATOR_NAME_CACHE

_props

private Object _props

_REMOVE_LISTENER_CACHE

private static Object _REMOVE_LISTENER_CACHE

_REMOVE_LISTENER_NAME_CACHE

private static Object _REMOVE_LISTENER_NAME_CACHE

STATE_COMPLETE

public static Object STATE_COMPLETE

UIComponent state indicating that all of the component's state is available

See also:

getReadyState()

STATE_LOADING

public static Object STATE_LOADING

UICOmponent state indicating that the component is still loading state or content

See also:

getReadyState()

USAGE_PRIVATE_CHILD

public static Object USAGE_PRIVATE_CHILD

This component is a private implementation detail of one of its ancestors

See also:

satisfiesUsage(Object)

Constructor Detail

AdfUIComponent

public AdfUIComponent(Object componentType)

AdfUIComponent base class

Parameters:

componentType

Method Detail

addEventListener

public Object addEventListener(Object eventType,
Object listener,
Object instance)

Adds a listener function of the specifed listener type. It is an error to attempt to add a null listener.

Parameters:

eventType
listener
instance

Return:

Object

AddNotify

protected Object AddNotify()

Return:

Object

broadcast

public Object broadcast(Object event)

Broadcasts the specified event on the component to the component's listeners

Parameters:

event

Return:

Object

_bubbleEvent

private Object _bubbleEvent(Object event)

Parameters:

event

Return:

Object

clearChanges

public Object clearChanges()

Return:

Object

clone

public Object clone()

Override to create new storage.

Return:

Object

Overrides:

AdfObject.clone()

ComparePropertyValues

protected Object ComparePropertyValues(Object propName,
Object oldValue,
Object newValue)

Compares the old value and the new value for a property and returns TRUE if they are equal.

Parameters:

propName
oldValue
newValue

Return:

Object

_createAccessorName

private static Object _createAccessorName(Object propertyName)

Given the name of a property, returns the name of the accessor convenience for that property.

Parameters:

propertyName

Return:

Object

createComponent

public static Object createComponent(Object componentType)

Creates a AdfUIComponent instance of the class with the closest match to the specified component type

Parameters:

componentType

Return:

Object

_createMutatorName

private static Object _createMutatorName(Object propertyName,
Object constantName)

Given the name of a property, returns the name of the mutator convenience for that property.

Parameters:

propertyName
constantName

Return:

Object

DeliverDerivedPropertyEvents

protected Object DeliverDerivedPropertyEvents(Object propName,
Object oldValue,
Object newValue)

Hook for subclasses to deliver events derived from property change events

Parameters:

propName
oldValue
newValue

Return:

Object

_deliverEvent

private Object _deliverEvent(Object event)

protected handling of the event

Parameters:

event

Return:

Object

_deliverEventToListener

private Object _deliverEventToListener(AdfBaseEvent event,
Object instance,
Function listener)

Delivers an event, either to a function or an AdfClientListener

Parameters:

event
instance	-	Default value = null
listener

Return:

Object

_deliverEventToListeners

private Object _deliverEventToListeners(AdfBaseEvent event,
Object listeners)

Delivers an event, either to a function or an AdfClientListener

Parameters:

event
listeners

Return:

Object

_findAbsoluteComponent

private static Object _findAbsoluteComponent(Object searchScopedId)

Find a component using an absolute scoped id

Parameters:

searchScopedId

Return:

Object

findComponent

public AdfUIComponent findComponent(String expr,
Boolean skipDeprecation)

Search for and return the AdfUIComponent with an id that matches the specified search expression. Component identifiers are required to be unique within the scope of the closest ancestor NamingContainer that encloses this component (which might be this component itself). If there are no NamingContainer components in the ancestry of this component, the root component in the tree is treated as if it were a NamingContainer, whether or not its class actually implements the NamingContainer interface. A search expression consists of either an identifier (which is matched exactly against the id property of a UIComponent, or a series of such identifiers linked by the NamingContainer.SEPARATOR_CHAR character value.

Parameters:

expr	-	A non-null search expression identifying the AdfUIComponent to be returned. Expressions are relative to this source component and must account for NamingContainers. Each colon beyond the first will pop out of a naming container. So "::" will either pop out of the current component if the current component is a naming container, or will pop out of the naming container of the current component if it is not a naming container. ":::" will search from the grandparent NamingContainer and up the comonent tree for each additional colon given. A single colon will search from the root.
skipDeprecation	-	Optional argument that defaults to false that if set to true relative searches will not attempt to use any deprecated syntaxes when attempting to find the component.

Return:

AdfUIComponent - the matching component instance, or undefined if no component matching that search expression exists

See also:

AdfPage.findComponentByAbsoluteId(String)

__findComponent

static Object __findComponent(Object expr,
Object component,
Object skipDeprecation)

Parameters:

expr
component
skipDeprecation

Return:

Object

findComponentByLocator

public AdfUIComponent findComponentByLocator(String locator)

Search for and return the AdfUIComponent with locator that matches the specified absolute locator expression.

Parameters:

locator

-

an implementation-agnostic String identifier. Provided primarily for test automation users. For most components, locator will be same as absoluteId, except in the case of stamping components like table.

Return:

AdfUIComponent - the matching component instance, or undefined if no component matching that absolute locator exists

See also:

AdfPage.findComponentByAbsoluteLocator(String)

__findComponentByLocator

static AdfUIComponent __findComponentByLocator(String locator,
Object component)

Search for and return the AdfUIComponent with locator that matches the specified absolute locator expression.

Parameters:

locator	-	an implementation-agnostic String identifier. Provided primarily for test automation users. For most components, absoluteLocator will be same as absoluteId, except in the case of stamping components like table.
component

Return:

AdfUIComponent - the matching component instance, or undefined if no component matching that absolute locator exists

See also:

AdfPage.findComponentByAbsoluteLocator(String)

_findRelativeComponent

private static Object _findRelativeComponent(Object clientId,
Object isNamingContainer,
Object ncCount,
Object searchClientId,
Object separator,
Object expr,
Object skipDeprecation)

Parameters:

clientId
isNamingContainer
ncCount
searchClientId
separator
expr
skipDeprecation

Return:

Object

focus

public Object focus()

Return:

Object

getAbsoluteId

public String getAbsoluteId()

Returns the absolute scoped id for this component without the leading ":". The result of this call may be passed either directly to AdfPage.findComponentByAbsoluteId or by prepending a ":", to AdfUIComponent.findComponent on any AdfUIComponent instance. to find this component instance as long as the component instance isn't stamped.

Return:

String - The absolute scoped id for the component

See also:

findComponent(String, Boolean)

AdfPage.findComponentByAbsoluteId(String)

getAbsoluteLocator

public String getAbsoluteLocator()

Returns the absolute locator, an implementation-agnostic String identifier. The result of this call can be passed directly to findComponentByAbsoluteLocator. The absolute locator can be used to locate any component instance stamped or otherwise. The absoluteId returned by getAbsoluteId can only be used to to find the component instance as long as it isn't stamped.

Return:

String - The absolute locator for the component

See also:

getAbsoluteId()

AdfPage.findComponentByAbsoluteLocator(String)

getAccessibleName

public String getAccessibleName()

Returns the localized String that represents the purpose of this Object. The Component is allowed to determine this name in any way it sees fit, including basing the value on properties of the component.
There is no guarantee that elements without full client-components will have a good accessible name, even if the appropriate attributes are set on the server.

Return:

String - The accessible name of the component or null if none is available.

GetChanges

protected Object GetChanges()

Return:

Object

getClientId

public Object getClientId()

Returns the client-specific ID for this component generated by the Server. The identifiers should not be persisted, as their contents are implementation-dependent and can change across releases.

For a stable id across releases, use a scoped id instead

Given the clientId, this component instance can be retrieved on the client by calling AdfPage.findComponent() on the client. On the server, this clientId can be passed to UIComponent.invokeOnComponent to execute code in this component's context.

Return:

Object

See also:

AdfPage.findComponent(String)

_getClientListeners

private Object _getClientListeners()

Return:

Object

getComponentType

public Object getComponentType()

Return:

Object

getDescendantComponents

public Object getDescendantComponents(Array<AdfUIComponent> children)

Get components descended from this component. This method should only be called if this component returns a value from AdfRichUIPeer.getDomElementForComponent(rootComponent);

There is no guarantee about the order of the children returned. If visiting the children in a known order is required please use AdfUIComponent.visitChildren.

All descendent children are returned, visible or not. If ignoring hidden children is required please use AdfUIComponent.visitChildren.

This method is faster than AdfUIComponent.visitChildren, if the limitations above are acceptable it is preferable to use this method.

Parameters:

children

-

array to store child components in. Descendent components will be added to the end of the array. This param is optional, if not passed in an array will be created.

Return:

Object - array of descendent components

getDragSource

public Object getDragSource()

Returns the AdfDragSource associated with this component. Components with a AdfDragSource can act as the source of a drag.

Return:

Object

getDropTarget

public Object getDropTarget()

Returns the AdfDropTarget associated with this component. Components with a AdfDropTarget can act as the destination of a drag.

Return:

Object

getInlineStyleProperty

public String getInlineStyleProperty(String propName)

returns the style values corresponding to the CSS propertyName.

The supplied parameter (propName) value should conform to CSS format and should be in lower case. for example, the method call to get the background color would be getInlineStyleProperty('background-color'). Note that 'backgroundColor' (DOM property) should not be passed as property name.

Parameters:

propName

-

The name of the css property to set

Return:

String - Returns the value corresponding to the CSS property

See also:

AdfUIPeer.getInlineStyleProperty(Object, String)

getParent

public Object getParent()

Return:

Object

getPeer

public Object getPeer()

Return:

Object

getProperty

public Object getProperty(Object propName)

Returns the raw value of a property. If the property is a function, the function is returned, rather than evaluated.

Parameters:

propName

Return:

Object

getPropertyKeys

public Object getPropertyKeys()

Returns the array of the keys of all properties available on this Component

Return:

Object

getPropertyValue

public Object getPropertyValue(Object propName)

Returns the evaluated value of a property. If the property is a function, the function is evaluated.

Parameters:

propName

Return:

Object

getReadyState

public Object getReadyState()

Returns whether the UIComponent is ready. The current possible values are:

• AdfUIComponent.STATE_LOADING The UIComponent is still loading state or content
• AdfUIComponent.STATE_COMPLETE The UIComponent is fully loaded

Return:

Object

GetSubclassPropertyKeys

protected static Object GetSubclassPropertyKeys()

Return:

Object

HandleBubbledEvent

protected Object HandleBubbledEvent(Object event)

Protected handling of a bubbled event

Parameters:

event

Return:

Object

HandleEvent

protected Object HandleEvent(Object event)

Protected default handling of an event. Called only for non-cancelled events. By default, events that should be propagated to the server will be queued for server delivery.

Parameters:

event

Return:

Object

Init

protected Object Init(Object componentType,
Object clientId,
Object properties,
Object usageFlags)

Initialize this component instance

Parameters:

componentType
clientId
properties
usageFlags

Return:

Object

Overrides:

AdfObject.Init()

_initAccessors

private static Object _initAccessors(Object ourClass,
Object propertyNames,
Object constantSuffix,
Object accessorPrefix,
Object mutatorPrefix)

Parameters:

ourClass
propertyNames
constantSuffix
accessorPrefix
mutatorPrefix

Return:

Object

_initBehaviors

private Object _initBehaviors(Object behaviors)

Parameters:

behaviors

Return:

Object

InitClass

protected static Object InitClass()

Initialize the constants of the AdfUIComponent class flatten the lists of propertyKeys and events Create the accessors and mutators for the lists.

AdfUIComponent subclasses that need to implement subclass-specific class initialization should write a static InitSubclass method. If present, this method will be called after the default class initialization with the subclass' constructor as the this parameter.

Return:

Object

initializeProperty

public Object initializeProperty(String propName,
Object newValue)

This method can be used to initialize an undefined property. It sets a property directly on the property map, which may be needed in limited circumstances during initialization.

Parameters:

propName	-	The name of the property to set
newValue	-	The value to set the property to

Return:

Object

isDescendant

public Object isDescendant(Object possibleAncestor)

Returns true if this AdfUIComponent is a descendant of the possibleAncestor

Parameters:

possibleAncestor

Return:

Object

isEventRoot

public Object isEventRoot()

Identifies if the component is an event root. Event roots will automatically set the root of events that are queued from inside of the component.

Return:

Object

__isNamingContainer

static Object __isNamingContainer(Object constructor)

Parameters:

constructor

Return:

Object

isShowing

public Object isShowing()

Returns true if the component is visible to the user

Return:

Object

_matchAbsoluteIdCallback

private static Object _matchAbsoluteIdCallback(Object component)

Callback called from AdfUIComponent._findAbsoluteComponent to match components

Parameters:

component

Return:

Object

processPushData

public Boolean processPushData(Object payload,
Number changeCount)

Called by the Active Data Service to deliver push data to the component.

Parameters:

payload	-	Peer-specific payload for the component
changeCount	-	Monotonically increasing Change count for this change

Return:

Boolean - Returns true if the component should continue to receive active data events.

queueEvent

public Object queueEvent(Object event)

Queues an event for delivery to this component. The default behavior is to queue the event for delivery at the end of the current processing cycle

Parameters:

event

Return:

Object

registerComponent

public static Object registerComponent(Object componentType,
Object componentClass)

Registers a mapping between the specified component type and the constructor of the AdfUIComponent subclass to instantiate in response to calls to AdfUIComponent.createComponent.

Parameters:

componentType
componentClass

Return:

Object

See also:

createComponent(Object)

removeEventListener

public Object removeEventListener(Object eventType,
Object listener,
Object instance)

Removes a listener function of the specifed listener type. It is an error to attempt to remove a null listener.

Parameters:

eventType
listener
instance

Return:

Object

RemoveNotify

protected Object RemoveNotify()

Return:

Object

_removePersistedFlag

private static Object _removePersistedFlag(Object propertyName)

Given the name of the property, strips of the persisted flag if present

Parameters:

propertyName

Return:

Object - propertyName with persistence flag removed if it contains

resizeNotify

public Object resizeNotify(Object oldWidth,
Object oldHeight,
Object newWidth,
Object newHeight)

Notification method called when browser window resize occurs. Only called for peers which indicate interest in resize notification by overriding needsResizeNotify().

Parameters:

oldWidth
oldHeight
newWidth
newHeight

Return:

Object

satisfiesUsage

public Object satisfiesUsage(Object usage)

Parameters:

usage

Return:

Object - null true if the component satisfies the specified usage

See also:

USAGE_PRIVATE_CHILD

scrollIntoView

public Object scrollIntoView(Boolean focus,
String subTargetId)

Scrolls this component into view.

Parameters:

focus	-	indicates if the component should be only scrolled into view or focus as well Default value = false
subTargetId	-	optional component dependent DOM sub-id that needs to be scrolled/focused into view Default value = null

Return:

Object

SetDisconnectedProperty

protected static Object SetDisconnectedProperty(Object componentClass,
Object propName)

Add protected utility method to set a property as disconnected

Parameters:

componentClass
propName

Return:

Object

setDragSource

public Object setDragSource(Object dragSource)

Sets the AdfDragSource associated with this component. Components with a AdfDragSource can act as the source of a drag.

Parameters:

dragSource

Return:

Object

setDropTarget

public Object setDropTarget(Object dropTarget)

Sets the AdfDropTarget associated with this component. Components with a AdfDropTarget can act as the destination of a drag.

Parameters:

dropTarget

Return:

Object

setInlineStyleProperty

public Object setInlineStyleProperty(String propName,
String propValue)

Sets the value for a given css style property.

The supplied parameter (propName) value should conform to CSS format and should be in lower case. for example, the method call to set the background color to blue would be setInlineStyleProperty('background-color','blue'). Note that 'backgroundColor' (DOM property) should not be passed as property name.

The property value set via setInlineStyleProperty will not be synchronized with the server-side property.

Parameters:

propName	-	The name of the css property to set
propValue	-	The value for this css property

Return:

Object

See also:

AdfUIPeer.setInlineStyleProperty(Object, String, String)

__setNamingContainer

static Object __setNamingContainer(Object constructor,
Object isNC)

Parameters:

constructor
isNC

Return:

Object

__setParent

Object __setParent(Object newParent)

Parameters:

newParent

Return:

Object

setProperty

public Object setProperty(String propName,
Object newValue,
Object persist,
Number propagate)

Sets a property on the component to a new value, firing a PropertyChangeEvent if the property's value has changed. All other property changing functions are merely conveniences built on this facility.

Changing the value of a property supported by the component will normmaly result in the new property value being synchronized with the server automatically. However, certain properties are never synchronized with the server for security reasons. Attempting to set one of these property will result in an Error being thrown.

Parameters:

propName	-	The name of the property to set
newValue	-	The new value for this property
persist
propagate	-	Determines whether the property change should be sent to the server Possible values are: AdfUIComponent.PROPAGATE_IF_KNOWN_PROPERTY (0) - If the property is known and not disconnected, the change will be sent to the server. Client-side property change events and derived events will be delivered. AdfUIComponent.PROPAGATE_ALWAYS (1) - Changes to any property will be sent to the server, except when a property is explicitly disconnected. Client-side property change events and derived events will be delivered. The server renderer must still have explicit code to receive an unknown property, so this cannot be used to force an attribute to the client AdfUIComponent.PROPAGATE_NEVER (2) - The property change will not be sent to the server. Client-side property change events and derived events will not be delivered. AdfUIComponent.PROPAGATE_LOCALLY (3) - The property change will not be sent to the server. Client-side property change events and derived events will be delivered.

Return:

Object - The old value of this property

Throws:

Error if an attempt is made to set a secured property.

See also:

AdfPropertyChangeEvent

SetPropertyImpl

protected Object SetPropertyImpl(Object propName,
Object oldValue,
Object newValue)

Subclass property change hook

Parameters:

propName
oldValue
newValue

Return:

Object

_setPropertyInfo

private static Object _setPropertyInfo(Function componentClass,
String propName,
String metadataProp,
Object metadataValue)

Private utility method to change the property type metadata.

Parameters:

componentClass	-	Component class to change type on
propName	-	a valid property name for this class
metadataProp	-	a valid metadata property name
metadataValue	-	new value for this metadata

Return:

Object

SetPropertyType

protected static Object SetPropertyType(Function componentClass,
String propName,
String typeName)

Protected utility method to change the default type of a proeprty. This is necessary to work around limitations in how the tools generate the metadata for our classes. Specifically, a subclass can't change the type of a property to a derived type

Parameters:

componentClass	-	Component class to change type on
propName	-	a valid property name for this class
typeName	-	a valid type name

Return:

Object

_setSource

private Object _setSource(Object source)

Parameters:

source

Return:

Object

toDebugString

public Object toDebugString()

Override to ditch "Object" and add the component type

Return:

Object

Overrides:

AdfObject.toDebugString()

_trimAbsoluteScopedId

private static Object _trimAbsoluteScopedId(Object absoluteScopedId,
Object trimCount)

Trim an absolute scoped id of the correct number of trailing sections including a trailing ":"

Parameters:

absoluteScopedId
trimCount

Return:

Object

visitChildren

public Number visitChildren(Function callback,
Object context,
Boolean ignoreHidden)

Visits all of the children components of the component. A callback function will be invoked with one argument - a component - and must return one of three values. If it returns the number zero (or false), iteration will continue. If it returns the number one (or true), iteration will not continue into the children. If it returns the number two, iteration will entirely halt. Iteration proceeds depth first, but calling the parents before the children

Please note that you do take a performance hit for using ignoreHidden.

Parameters:

callback	-	a function that will be called on each child
context	-	an object that will be set as "this" when the callback is invoked; can be null if no context is required.
ignoreHidden	-	if true, hidden DOM nodes will be skipped

Return:

Number - null

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD