JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlLookAndFeel

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfLookAndFeel
               |
               +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlLookAndFeel

public class AdfDhtmlLookAndFeel
extends AdfLookAndFeel

_COMPONENT_TO_PEER_NAME

private static Object _COMPONENT_TO_PEER_NAME

_DEFAULT_CONSTRUCTOR_KEY

private static Object _DEFAULT_CONSTRUCTOR_KEY

EVENT_TYPE_TO_ATTRIBUTE_MAP

public static Object EVENT_TYPE_TO_ATTRIBUTE_MAP

EVENT_TYPE_TO_CAMEL_CASE_MAP

public static Object EVENT_TYPE_TO_CAMEL_CASE_MAP

_window

private Object _window

AdfDhtmlLookAndFeel

public AdfDhtmlLookAndFeel(Object domWindow)

DHTML AdfLookAndFeel base class

Parameters:

domWindow

addSkinProperties

public static Object addSkinProperties(Object props)

Add skin properties. An internal utility function - do not call. This method needs to be exported (along with the class itself) because it is called from the generated HTML

Parameters:

props

Return:

Object

createPage

public Object createPage()

Override to create the DHTML implementation of the AdfPage

Return:

Object

Overrides:

AdfLookAndFeel.createPage()

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.

Each icon is identified by an icon key, e.g., "af|message::error-icon"

Parameters:

key

-

Key used to identify this icon

Return:

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

Overrides:

AdfLookAndFeel.getIcon(String)

getPeer

public Object getPeer(Object 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

Return:

Object

Overrides:

AdfLookAndFeel.getPeer(AdfUIComponent)

getRawIcon

public HTMLElement getRawIcon(String key)

Given a key that identifies an icon, return the raw icon element. Do not use this function to add the icon element elsewhere on the page because you do not want to modify the icon markup that is sent from the server; instead use #getIcon which returns a cloned node of the icon. This function is useful if you need to compare the icon's markup using the span's innerHTML.

Each icon is identified by an icon key, e.g., "af|message::error-icon"

Parameters:

key

-

Key used to identify this icon

Return:

HTMLElement - The icon element, null if the icon can't be found.

See also:

AdfDomUtils.swapIcon(HTMLElement, String)

getIcon(String)

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

Overrides:

AdfLookAndFeel.getSkinProperty(String)

getStyleClass

public Object getStyleClass(String styleClass)

Returns a compressed style class.

Parameters:

styleClass

-

the uncompressed styleClass

Return:

Object - the compressed style class, or the original class if no compressed version is available

getTranslatedString

public Object getTranslatedString(String key,
                                  Object params)

Override to return the translations for the DhtmlLookAndFeel.

Parameters:

key	-	the translations resource key
params

Return:

Object

Overrides:

AdfLookAndFeel.getTranslatedString(String)

Init

protected Object Init(Object domWindow)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:

domWindow

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected static Object InitClass()

Initializes the AdfDhtmlLookAndFeel class

Return:

Object

registerPeerConstructor

public AdfRichUIPeer 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:

AdfRichUIPeer - null

Overrides:

AdfLookAndFeel.registerPeerConstructor(String, String)