JavaScript API Reference for Oracle ADF Faces

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

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

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

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

public class AdfDhtmlShadowDecorator
extends AdfObject

AdfDhtmlShadowDecorator is used to decorate a DOM element with shadow. This object basically creates transparent div elements underneath the DOM element for the shadows. This object also creates a iframe underneath to clip any OS drawn controls

Field Summary

public static Object	SHADOW_ANCHOR_ATTRIBUTE
private static Object	_SHADOW_DECORATOR_ATTRIBUTE

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlShadowDecorator() AdfDhtmlShadowDecorator is used to decorate a DOM element with shadow.

Method Summary

private Object	_create(HTMLElement element, Object appendToElement, Number shadowOffsetTop, Number shadowOffsetLeft, Boolean isRelative, Number startingBlackPercent) Creates the DOM elements for the shadow associated with a given element.
public static Object	createShadowDecorator(HTMLElement element, HTMLElement rootElement, Boolean isRelative) Create the shadow decorator for a floating dom element.
private static Object	_getShadowDecorator(Object element) Returns the shadow decorator for the element
private static Number	_getShadowOffset() Get the pixel offset value for the shadow.
public static Number	getShadowSize() Get the pixel size of the shadow.
private static Number	_getShadowStartingBlackPercent() Get the starting black percent value for the shadow.
public static Object	hasShadowDecorator(Object element) returns if a dom element is associated with the shadow decorator
protected Object	Init() Initializes the instance.
private Object	_move(Object element) Moves the DOM elements for the shadow associated with a given element.
public static Object	moveShadowDecorator(Object element) Moves the shadow decorator for a dom element
private Object	_remove(Object element) Removes the DOM elements for the shadow associated with a given element
public static Object	removeShadowDecorator(Object element) Removes the shadow decorators for a dom element
public static Object	setRelative(Object element, Object relative)
private Object	_show(Object element, Object show) Hides/Shows the DOM elements for the shadow associated with a given element.
public static Object	showShadowDecorator(Object element, Object show) Hides/Shows the shadow decorators for a dom element

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

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

Field Detail

SHADOW_ANCHOR_ATTRIBUTE

public static Object SHADOW_ANCHOR_ATTRIBUTE

_SHADOW_DECORATOR_ATTRIBUTE

private static Object _SHADOW_DECORATOR_ATTRIBUTE

Constructor Detail

AdfDhtmlShadowDecorator

public AdfDhtmlShadowDecorator()

AdfDhtmlShadowDecorator is used to decorate a DOM element with shadow. This object basically creates transparent div elements underneath the DOM element for the shadows. This object also creates a iframe underneath to clip any OS drawn controls

Method Detail

_create

private Object _create(HTMLElement element,
Object appendToElement,
Number shadowOffsetTop,
Number shadowOffsetLeft,
Boolean isRelative,
Number startingBlackPercent)

Creates the DOM elements for the shadow associated with a given element. NOTE: There is no back pointer to the DOM element to avoid memory leaks in IE

Parameters:

element	-	The element for which the decorator needs creation
appendToElement
shadowOffsetTop	-	The y offset of the shadow, default value is 3 if null is provided Default value = 3
shadowOffsetLeft	-	The x offset of the shadow, default value is 3 if null is provided Default value = 3
isRelative	-	Indicates if the shadow is relatively positioned.
startingBlackPercent	-	The starting black percent level for the shade (effects darkness/lighness of drop shadow). Default value = 100

Return:

Object

createShadowDecorator

public static Object createShadowDecorator(HTMLElement element,
HTMLElement rootElement,
Boolean isRelative)

Create the shadow decorator for a floating dom element. Also creates a masking iframe to clip any OS drawn controls under the element

Parameters:

element	-	The element for which the decorator needs creation
rootElement	-	The element to append the shadow to, if omitted this will be the body
isRelative	-	Indicates if the shadow is relatively positioned.

Return:

Object

_getShadowDecorator

private static Object _getShadowDecorator(Object element)

Returns the shadow decorator for the element

Parameters:

element

Return:

Object

_getShadowOffset

private static Number _getShadowOffset()

Get the pixel offset value for the shadow. This value is retrieved from the skinning file.

Return:

Number - Pixel size value of the shadow

getShadowSize

public static Number getShadowSize()

Get the pixel size of the shadow. This value is retrieved from the skinning file.

Return:

Number - Pixel size value of the shadow

_getShadowStartingBlackPercent

private static Number _getShadowStartingBlackPercent()

Get the starting black percent value for the shadow. This value is retrieved from the skinning file.

Return:

Number - Starting black percent value for the shadow

hasShadowDecorator

public static Object hasShadowDecorator(Object element)

returns if a dom element is associated with the shadow decorator

Parameters:

element

Return:

Object

Init

protected Object Init()

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

Return:

Object

Overrides:

AdfObject.Init()

_move

private Object _move(Object element)

Moves the DOM elements for the shadow associated with a given element.

Parameters:

element

Return:

Object

moveShadowDecorator

public static Object moveShadowDecorator(Object element)

Moves the shadow decorator for a dom element

Parameters:

element

-

The element for which the decorator needs to be moved

Return:

Object

_remove

private Object _remove(Object element)

Removes the DOM elements for the shadow associated with a given element

Parameters:

element

Return:

Object

removeShadowDecorator

public static Object removeShadowDecorator(Object element)

Removes the shadow decorators for a dom element

Parameters:

element

-

The element for which the decorator needs to be removed

Return:

Object

setRelative

public static Object setRelative(Object element,
Object relative)

Parameters:

element
relative

Return:

Object

_show

private Object _show(Object element,
Object show)

Hides/Shows the DOM elements for the shadow associated with a given element.

Parameters:

element
show

Return:

Object

showShadowDecorator

public static Object showShadowDecorator(Object element,
Object show)

Hides/Shows the shadow decorators for a dom element

Parameters:

element	-	The element for which the decorator needs to be hidden
show	-	boolean true to show the shadow, else false

Return:

Object

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