JavaScript API Reference for Oracle ADF Faces

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

oracle.adf.view.js.base
Class AdfLookAndFeel

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

Direct Known Subclasses:

AdfDhtmlLookAndFeel

public abstract class AdfLookAndFeel
extends AdfObject

AdfLookAndFeel base class. The AdfLookAndFeel serves as a factory for the patform-specific implementation objects used by the framework, namely the AdfPage object and the correct AdfUIPeer instances for the AdfUIComponents.

This class is normally called by the framework. The method of most interest to component authors is registerPeerConstructor, which allows a component author to register the peer to be used to implement a component.

See also:

registerPeerConstructor(String, String)

Field Summary

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Method Summary

public AdfPage	createPage() Creates the instance of the correct subclass of the AdfPage Object.
public HTMLElement	getIcon(String key) Given a key that identifies an icon, return an icon node.
public AdfUIPeer	getPeer(AdfUIComponent component) Returns an uninitialized peer for this component.
public Object	getSkinProperty(String key) Returns the skin property with the specified key for the look and feel
public Object	getTranslatedString(String key) Returns the translated string with the specified key for the look and feel
public Object	registerPeerConstructor(String componentType, String peerConstructorName) Registers a peer constructor for the specified component type.

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

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

Field Detail

Method Detail

createPage

public AdfPage createPage()

Creates the instance of the correct subclass of the AdfPage Object. This method will be called during the bootstrap process to initialize the value of AdfPage.PAGE. Different rendering technologies to override this method to return the correct AdfPage subclass for their implementation.

Return:

AdfPage - The AdfPage instance referencable through AdfPage.PAGE

getIcon

public HTMLElement getIcon(String key)

Given a key that identifies an icon, return an icon node. This can be used to add an icon to the page on the client. This function returns a cloned node of the icon markup that is sent from the server so that the icon markup sent from the server is not accidentally modified.

Parameters:

key

-

Key used to identify this icon

Return:

HTMLElement - An icon node, null if the icon can't be found.

getPeer

public AdfUIPeer getPeer(AdfUIComponent component)

Returns an uninitialized peer for this component. The peer must be initialized by calling peer.initialize() before it is used the first time by this component.

Parameters:

component

-

Component to retrieve peer for.

Return:

AdfUIPeer - Uninitialized peer instance for the specified component

See also:

AdfUIPeer.initialize(AdfUIComponent)

getSkinProperty

public Object getSkinProperty(String key)

Returns the skin property with the specified key for the look and feel

Parameters:

key

-

Key used to identify this skin property

Return:

Object - The skin property

getTranslatedString

public Object getTranslatedString(String key)

Returns the translated string with the specified key for the look and feel

Parameters:

key

-

the translations resource key

Return:

Object

registerPeerConstructor

public Object registerPeerConstructor(String componentType,
String peerConstructorName)

Registers a peer constructor for the specified component type. Custom component developers can use this method to register their peers. Note that the peerConstructor is actually the name of the constructor, not the constructor itself

Parameters:

componentType	-	of components to use this peer with
peerConstructorName	-	name of peer's constructor

Return:

Object

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