|
Oracle Fusion Middleware JavaScript API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E12046-05 |
||||||||
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |
org.ecmascript.object.Object | +--oracle.adf.view.js.base.AdfObject | +--oracle.adf.view.js.base.AdfUIPeer
public class AdfUIPeer extends AdfObject
Field Summary |
|
---|---|
private static Object |
Fields inherited from oracle.adf.view.js.base.AdfObject |
constructor, superclass |
Fields inherited from org.ecmascript.object.Object |
prototype |
Constructor Summary |
|
---|---|
public |
|
Method Summary |
|
---|---|
protected Object |
|
public Object |
|
public String |
|
public static Object |
|
protected Object |
|
public Object |
|
public String |
|
public String |
|
public AdfUIComponent |
|
public AdfUIComponent |
|
public Object |
|
public AdfDragRecognizer |
|
public Array<AdfUIComponent> |
|
public Object |
|
public Object |
|
public String |
|
public Object |
|
public Object |
|
public Object |
|
protected Object |
|
protected static Object |
|
public Object |
|
public Object |
|
public Object |
|
public Object |
|
public Object |
|
public Object |
|
public Boolean |
|
public Object |
|
public Object |
|
public Number |
|
Methods inherited from oracle.adf.view.js.base.AdfObject |
adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString |
Field Detail |
---|
private static Object _DRAG_RECOGNIZER
Constructor Detail |
---|
public AdfUIPeer()
Method Detail |
---|
protected Object ComponentPropertyChanged(Object propertyChangeEvent)
propertyChangeEvent |
Object
public Object componentRemoved(AdfUIComponent component)
component |
- | The UIComponent that is being removed |
Object
initialize(AdfUIComponent)
public String convertLocatorToClientId(Object component,
Object stampKey)
The peer is not bound when this method is called
Peers that need to replace and skip extra fragments when converting from clientIds to absolute locators such as Tables and Regions should override this method to add the index of the fragment to be replaced and skipped.component |
- | The component for this peer |
stampKey |
- | the stamp key which need to be replaced |
String
- the client id fragment in the below format clientId + ":" + stamped index of client Id fragment related to stampKeypublic static Object createPeerClass(Object theSuperclass,
Object peerName)
theSuperclass |
||
peerName |
Object
protected Object DispatchComponentEvent(Object componentEvent)
componentEvent |
Object
public Object focus(Object component)
component |
Object
public String getAbsoluteId(AdfUIComponent component,
String clientId)
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.component |
- | The component for which absolute id need to be retrieved. |
clientId |
- | the implementation-specific client id of the component |
String
- The absolute scoped id for the componentAdfUIComponent.getAbsoluteId()
AdfUIComponent.findComponent(String, Boolean)
AdfPage.findComponentByAbsoluteId(String)
public String getAbsoluteLocator(AdfUIComponent component,
String clientId)
component |
- | The component for which absolute locator need to be retrieved. |
clientId |
- | the implementation-specific client id of the component |
String
- The absolute locator for the componentAdfUIComponent.getAbsoluteId()
AdfPage.findComponentByAbsoluteLocator(String)
public AdfUIComponent getComponent()
AdfUIComponent
- The associated componentpublic AdfUIComponent getComponentParent(AdfUIComponent component)
component |
- | Component to determine the parent component of. |
AdfUIComponent
- The parent component, if any.public Object getComponentProperty(AdfUIComponent component,
String propertyName)
undefined
if the peer does not know how to derive the propertycomponent |
- | Component to retrieve the property for |
propertyName |
- | Name of component property to retrieve the value of |
Object
- Value of the propertypublic AdfDragRecognizer getDefaultDragRecognizer(AdfUIComponent component)
Returns the default AdfDragReconizer to use if the AdfDragSource does not provide its own drag recognition scheme.
The default implementation will start a drag anywhere in the component. Override with a different AdfDragRecognizer strategy if the peer wants to restrict the portion of the component that can initiate drags.
component |
- | the component for this peer |
AdfDragRecognizer
- The default drag recognizer to usepublic Array<AdfUIComponent> getDescendantComponents(AdfUIComponent component,
Array<AdfUIComponent> children)
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.
Returns an array of descendant (child) components for this component.component |
- | this component |
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. |
Array<AdfUIComponent>
- array of child components, may be emptypublic Object getDragOverFeedback(AdfUIComponent component,
AdfUIInputEvent inputEvent)
component |
- | the component for this peer |
inputEvent |
- | the inputEvent that triggered the drag |
Object
- Appropriate feedback object. For HTML, this is an HTML Nodepublic Object getDragTransferable(AdfUIComponent component,
AdfUIInputEvent inputEvent)
null
if this peer has no default Transferable.component |
- | the component for this peer |
inputEvent |
- | the inputEvent that triggered the drag |
Object
- null (AdfTransferable} Default transferable object, or null
if no default transferablepublic String getInlineStyleProperty(Object component,
String propName)
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.
component |
||
propName |
- | The name of the css property to set |
String
- Returns the value corresponding to the CSS propertypublic Object getPagePosition(AdfUIComponent component)
component |
- | the component for this peer |
Object
- an object with two properties (x for the left coordinate and y for the top coordinate)public Object getParentPeer()
Object
public Object getReadyState(Object component)
AdfUIComponent.STATE_LOADING
The UIComponent is still loading state or contentAdfUIComponent.STATE_COMPLETE
The UIComponent is fully loadedcomponent |
Object
protected Object Init(AdfUIComponent component)
component |
- | Component to associate with this peer |
Object
AdfObject.Init()
protected static Object InitClass()
Object
public Object initialize(AdfUIComponent component)
component |
- | to associate with this peer instance |
Object
componentRemoved(AdfUIComponent)
public Object initiateDrag(Object dndContext,
Object triggerEvent)
dndContext |
||
triggerEvent |
Object
public Object isVisible()
Object
public Object messageNotify(Object component,
Number maxtype,
Array messages)
null
then all the messages have been cleared from this component.component |
- | the component that these messages are for |
maxtype |
- | the maximum message type. Starts with INFO and works it's way up. The message type constants are defined in AdfFacesMessage object and may be retrieved from any javascript faces message by running AdfFacesMessage.getTypeFromMessage(); |
messages |
- | the messages for this component |
Object
public Object messageShow(Object component,
Number maxtype,
Array messages)
null
then all the messages have been cleared from this component.component |
- | the component that these messages are for |
maxtype |
- | the maximum message type. Starts with INFO and works it's way up. The message type constants are defined in AdfFacesMessage object and may be retrieved from any javascript faces message by running AdfFacesMessage.getTypeFromMessage(); |
messages |
- | the messages for this component |
Object
public Object needsResizeNotify(Object component)
component |
Object
public Boolean processPushData(AdfUIComponent component,
Object payload,
Boolean isLate)
component |
- | Component to associate with this peer |
payload |
- | Peer-specific payload for the component |
isLate |
- | True if the data is later than it is supposed to be |
Boolean
- Returns true
if the component should continue to receive active data events.public Object resizeNotify(Object component,
Object oldWidth,
Object oldHeight,
Object newWidth,
Object newHeight)
component |
||
oldWidth |
||
oldHeight |
||
newWidth |
||
newHeight |
Object
public Object setInlineStyleProperty(Object component,
String propName,
String propValue)
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.
component |
||
propName |
- | The name of the css property to set |
propValue |
- | The value for this css property |
Object
public Number visitChildren(AdfUIComponent component,
Function callback,
Object context,
Boolean ignoreHidden)
component |
- | the component for this peer |
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 |
Number
- null
|
Oracle Fusion Middleware JavaScript API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E12046-05 |
||||||||
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |