JavaScript API Reference for Oracle ADF Faces

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

oracle.adfinternal.view.js.laf.dhtml.internalWindow
Class AdfDhtmlZOrderManager

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.internalWindow.AdfDhtmlZOrderManager

public class AdfDhtmlZOrderManager
extends AdfObject

AdfDhtmlZOrderManager

Field Summary

private static Object	_BLANK_PAGE_RESOURCE
public static Object	FLOATINGTYPE_MASKINGFRAME
public static Object	FLOATINGTYPE_TOOLTIP
public static Object	FLOATINGTYPE_WINDOW
private static Object	_FORM_ID_EXPANDO
private static Object	_INUSE_EXPANDO
private Object	_isGecko
private static Object	_LAYER_CONTAINER_STYLECLASS
private static Object	_LAYER_STYLECLASS
public static Object	LAYERCONTAINER
private Object	_layerHash
public static Object	LAYERIDS
private static Object	_MAXZ
private static Object	_SHADOWDECORATORZINDEX

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlZOrderManager() AdfDhtmlZOrderManager

Method Summary

public void	addElementToLayer(HTMLElement element, String layerId, HTMLElement priorElement, String formId) Adds an element to a specific layer.
private Object	_addLayer(HTMLElement layerContainer, String layer, HTMLElement layerElement) Appends the layer to the documentElement, and thus making it the highest in z-ordering.
private Boolean	_assertLayers(String formId) Checks if the layerContainer is still located under the first form or body.
public Boolean	containsElement(HTMLElement element) Checks to see if the active layer container is within a dom element.
private HTMLElement	_createLayerElement(Object id) Used for creating new layers to contain a specific collection of similar elements.
private HTMLElement	_createLayers(String formId) Creates layers (AdfDhtmlZOrderLayer) for each layer in LAYERIDS.
private static String	_createMapSafeKey(String layerId) Replaces all ":" char's with "$" to create a type safe map key.
public HTMLElement	createMaskingFrame(HTMLElement element) Returns an iframe that is marked as in use.
public void	dispose() Removes the internal collections used to manage dom nodes.
private static boolean	_findMaskingFramesInUse(AdfDhtmlZOrderLayer layer, HTMLElement element) Visitor callback passed to the masking frame layer.
public Number	getElementCount()
private static HTMLElement	_getFormOrBody(String formId) Looks at the domDocument and retruns the first form or the body element.
private AdfDhtmlZOrderLayer	_getLayer(String id)
private HTMLElement	_getLayerContainer(String formId) Get the layer container from the page.
public static Number	getMaxZIndex()
protected Object	Init() Initializes the instance.
protected static Object	InitClass()
private void	_positionLayerContainer(Object layerContainer) Appends the layerContainer to the body and makes it fixed to position 0,0.
public HTMLElement	prepareMaskingFrame(HTMLElement element) Finds the first unused iframe in the masking frame layer.
public void	raiseToFront(Object element) Makes an element the topmost visible in its layer, by making it the last child (and not traversing itself in DOM)
public void	removeElement(HTMLElement element) Unregister the element from the zorder manager.
public void	removeMaskingFrame(HTMLElement maskFrame) Adds the masking frame back into the pool.
private void	_repairLayers(Object layerContainer) Puts all layers at the end of the body or first form or body.
private void	_setLayer(String id, AdfDhtmlZOrderLayer layer) Adds the layer to a local cache by id.

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

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

Field Detail

_BLANK_PAGE_RESOURCE

private static Object _BLANK_PAGE_RESOURCE

FLOATINGTYPE_MASKINGFRAME

public static Object FLOATINGTYPE_MASKINGFRAME

FLOATINGTYPE_TOOLTIP

public static Object FLOATINGTYPE_TOOLTIP

FLOATINGTYPE_WINDOW

public static Object FLOATINGTYPE_WINDOW

_FORM_ID_EXPANDO

private static Object _FORM_ID_EXPANDO

_INUSE_EXPANDO

private static Object _INUSE_EXPANDO

_isGecko

private Object _isGecko

_LAYER_CONTAINER_STYLECLASS

private static Object _LAYER_CONTAINER_STYLECLASS

_LAYER_STYLECLASS

private static Object _LAYER_STYLECLASS

LAYERCONTAINER

public static Object LAYERCONTAINER

_layerHash

private Object _layerHash

LAYERIDS

public static Object LAYERIDS

_MAXZ

private static Object _MAXZ

_SHADOWDECORATORZINDEX

private static Object _SHADOWDECORATORZINDEX

Constructor Detail

AdfDhtmlZOrderManager

public AdfDhtmlZOrderManager()

AdfDhtmlZOrderManager

Method Detail

addElementToLayer

public void addElementToLayer(HTMLElement element,
String layerId,
HTMLElement priorElement,
String formId)

Adds an element to a specific layer. You can specify that the element is to be inserted before the prior element.

Parameters:

element	-	the element to add
layerId	-	the floatingType indicating the layer to append to
priorElement	-	optional dom element that element should be inserted before
formId	-	client id of the form element the container should be located. If null, the container will be under the document.

Return:

void - null

_addLayer

private Object _addLayer(HTMLElement layerContainer,
String layer,
HTMLElement layerElement)

Appends the layer to the documentElement, and thus making it the highest in z-ordering.

Parameters:

layerContainer	-	the container where the layer is added
layer	-	the layer to add
layerElement	-	layer dom element added to the container

Return:

Object

_assertLayers

private Boolean _assertLayers(String formId)

Checks if the layerContainer is still located under the first form or body.

Parameters:

formId

-

clientId if the form element the container should exist.

Return:

Boolean - true if the container is valid; otherwise, returns false

containsElement

public Boolean containsElement(HTMLElement element)

Checks to see if the active layer container is within a dom element.

Parameters:

element

-

body or form element

Return:

Boolean - true if the active container is within the element

_createLayerElement

private HTMLElement _createLayerElement(Object id)

Used for creating new layers to contain a specific collection of similar elements.

Parameters:

id

-

the id or name of the layer

Return:

HTMLElement - new layer (DIV)

_createLayers

private HTMLElement _createLayers(String formId)

Creates layers (AdfDhtmlZOrderLayer) for each layer in LAYERIDS.

Parameters:

formId

-

clientId of the form element that contains the container

Return:

HTMLElement - layerContainer for a form or body

_createMapSafeKey

private static String _createMapSafeKey(String layerId)

Replaces all ":" char's with "$" to create a type safe map key.

Parameters:

layerId

-

subid of the layer dom element

Return:

String - map safe key

createMaskingFrame

public HTMLElement createMaskingFrame(HTMLElement element)

Returns an iframe that is marked as in use. The iframe is layered behind floating elements to prevent bleed through of applets.

Parameters:

element

-

the element underneath which to create the masking frame

Return:

HTMLElement - returns a masking frame

dispose

public void dispose()

Removes the internal collections used to manage dom nodes.

Return:

void - null

_findMaskingFramesInUse

private static boolean _findMaskingFramesInUse(AdfDhtmlZOrderLayer layer,
HTMLElement element)

Visitor callback passed to the masking frame layer. Finds the first unused masking frame.

Parameters:

layer	-	the element belongs to
element	-	managed by the zorder manager in a layer

Return:

boolean - null true if an active masking frame was found

getElementCount

public Number getElementCount()

Return:

Number - the total number of DOM elements managed in all containers

_getFormOrBody

private static HTMLElement _getFormOrBody(String formId)

Looks at the domDocument and retruns the first form or the body element.

Parameters:

formId

-

clientId of the form element the container should be placed; if null, default to the body

Return:

HTMLElement - first form or body element

_getLayer

private AdfDhtmlZOrderLayer _getLayer(String id)

Parameters:

id

-

of the target layer

Return:

AdfDhtmlZOrderLayer - target layer of null if not found

_getLayerContainer

private HTMLElement _getLayerContainer(String formId)

Get the layer container from the page.

Parameters:

formId

-

clientId of the form element the container should exist. if null, we default to the body element.

Return:

HTMLElement - target container for contained form

getMaxZIndex

public static Number getMaxZIndex()

Return:

Number - maximum zindex used by the zorder container

Init

protected Object Init()

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

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected static Object InitClass()

Return:

Object

_positionLayerContainer

private void _positionLayerContainer(Object layerContainer)

Appends the layerContainer to the body and makes it fixed to position 0,0.

Parameters:

layerContainer

-

the container for the layers

Return:

void - null

prepareMaskingFrame

public HTMLElement prepareMaskingFrame(HTMLElement element)

Finds the first unused iframe in the masking frame layer. If one does not exists, a new iframe is created and added to the pool. The iframe returned from this call is not marked as in use.

Parameters:

element

-

the element underneath which to create the masking frame

Return:

HTMLElement - iframe free in the pool that is not in use

raiseToFront

public void raiseToFront(Object element)

Makes an element the topmost visible in its layer, by making it the last child (and not traversing itself in DOM)

Parameters:

element

-

the element to raise

Return:

void - null

removeElement

public void removeElement(HTMLElement element)

Unregister the element from the zorder manager.

Parameters:

element

-

target floating element

Return:

void - null

removeMaskingFrame

public void removeMaskingFrame(HTMLElement maskFrame)

Adds the masking frame back into the pool.

Parameters:

maskFrame

-

the maskFrame instance to be reused

Return:

void - null

_repairLayers

private void _repairLayers(Object layerContainer)

Puts all layers at the end of the body or first form or body. The importance of insisting that the zorder container is the last sibling of the form or body is that the zindex is relative to where its defined in the document. If a node is positioned after the zorder container the popup might not always be on top. This is seen when two popup are displayed and the zorder container is define in the form of the associated popup. The popup from the last form in the document will have a greater relative layer regardless of the zindex.

Parameters:

layerContainer

-

the container for the layers

Return:

void - null

_setLayer

private void _setLayer(String id,
AdfDhtmlZOrderLayer layer)

Adds the layer to a local cache by id.

Parameters:

id	-	if the layer
layer	-	object

Return:

void - null

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