OracleJavaScript API Reference for Oracle ADF Faces

 

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

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

Warning:

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

public static Object
FLOATINGTYPE_MASKINGFRAME
public static Object
FLOATINGTYPE_TOOLTIP
public static Object
FLOATINGTYPE_WINDOW
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 Object
addElementToLayer(HTMLElement element, String layerId, HTMLElement priorElement)
Adds an element to a specific layer.
private Object
_addLayer(String layerContainer, String layer)
Appends the layer to the documentElement, and thus making it the highest in z-ordering.
private Boolean
_assertLayers()
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 Object
_createLayers()
Creates layers (AdfDhtmlZOrderLayer) for each layer in LAYERIDS.
public HTMLElement
createMaskingFrame()
Returns an iframe that is marked as in use.
public Object
dispose()
Removes the internal collections used to manage dom nodes.
private static Object
_findMaskingFramesInUse(AdfDhtmlZOrderLayer layer, HTMLElement element)
Visitor callback passed to the masking frame layer.
public Number
getElementCount()
private static HTMLElement
_getFormOrBody(Object domDocument)
Looks at the domDocument and retruns the first form or the body element.
private Object
_getLayer(Object id)
private Object
_getLayerContainer()
Get the layer container from the page.
public static Number
getMaxZIndex()
protected Object
Init()
Initializes the instance.
protected static Object
InitClass()
private Object
_positionLayerContainer(Object layerContainer)
Appends the layerContainer to the body and makes it fixed to position 0,0.
public HTMLElement
prepareMaskingFrame()
Finds the first unused iframe in the masking frame layer.
public Object
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 Object
removeElement(HTMLElement element)
Unregister the element from the zorder manager.
public Object
removeMaskingFrame(Object maskFrame)
Adds the masking frame back into the pool.
private Object
_repairLayers(Object layerContainer)
Puts all layers at the end of the body or first form.


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

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


Field Detail


FLOATINGTYPE_MASKINGFRAME

public static Object FLOATINGTYPE_MASKINGFRAME

FLOATINGTYPE_TOOLTIP

public static Object FLOATINGTYPE_TOOLTIP

FLOATINGTYPE_WINDOW

public static Object FLOATINGTYPE_WINDOW

_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 Object addElementToLayer(HTMLElement element,
                                String layerId,
                                HTMLElement priorElement)

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
Return:
Object

_addLayer

private Object _addLayer(String layerContainer,
                         String layer)

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
Return:
Object

_assertLayers

private Boolean _assertLayers()

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

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 Object _createLayers()

Creates layers (AdfDhtmlZOrderLayer) for each layer in LAYERIDS.

Return:
Object - layerContainer

createMaskingFrame

public HTMLElement createMaskingFrame()

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

Return:
HTMLElement - returns an iframe

dispose

public Object dispose()

Removes the internal collections used to manage dom nodes.

Return:
Object

_findMaskingFramesInUse

private static Object _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:
Object

getElementCount

public Number getElementCount()

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

_getFormOrBody

private static HTMLElement _getFormOrBody(Object domDocument)

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

Parameters:
domDocument  -  root document node
Return:
HTMLElement - first form or body element

_getLayer

private Object _getLayer(Object id)

Parameters:
id    
Return:
Object

_getLayerContainer

private Object _getLayerContainer()

Get the layer container from the page.

Return:
Object

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 Object _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:
Object

prepareMaskingFrame

public HTMLElement prepareMaskingFrame()

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.

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

raiseToFront

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

removeElement

public Object removeElement(HTMLElement element)

Unregister the element from the zorder manager.

Parameters:
element  -  target floating element
Return:
Object

removeMaskingFrame

public Object removeMaskingFrame(Object maskFrame)

Adds the masking frame back into the pool.

Parameters:
maskFrame  -  the maskFrame instance to be reused
Return:
Object

_repairLayers

private Object _repairLayers(Object layerContainer)

Puts all layers at the end of the body or first form.

Parameters:
layerContainer  -  the container for the layers
Return:
Object

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

 

Generated on 2011.04.27 02:28 UTC
Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.