JavaScript API Reference for Oracle ADF Faces

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

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

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.AdfAbstractFloatingElement
               |
               +--oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfDhtmlPopupWindow
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfDhtmlPopupMenu

public class AdfDhtmlPopupMenu
extends AdfDhtmlPopupWindow

A popup window that is used to diplay components with a menu display style

Field Summary

public Object

setShadowAnchor

Fields inherited from oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfDhtmlPopupWindow

__CANCELED_EXPANDO, __POPUPID_EXPANDO, __REPLACEDOM_EXPANDO, setElement

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlPopupMenu() A popup window that is used to diplay components with a menu display style

Method Summary

public Object	activate() Focus on the first element.
protected HTMLElement	CreateDomElement() Create and initialize the html.
protected Object	CreateShadow(Boolean afterAnimation) Creates the shadow for this popup window
protected Object	DoResizeNotifyDom(Object content) For now there is no use case for geometry management of the menu content.
protected Object	GetAnimationDurationSkinProperty() Returns the skin property for animation duriation
protected HTMLElement	GetContentParent() Gets the dom element that is the parent of the popup's content.
private Object	_getFirstMenuItem(AdfUIComponent component) Inspects the content of the AdfRichMenu and returns the first menu item - commandMenuItem (AdfRichCommandMenuItem component), goMenuItem (AdfRichGoMenuItem component), or submenu (AdfRichMenu component).
protected HTMLElement	GetFocusContent() Returns the first command menu item, submenu, or dom node of the floating element.
protected Object	GetLaunchSourceElement() Get the launch source element (if available), which is the last menuBar item that had focus.
protected Object	Init() Initializes the instance.
protected static Object	InitClass()
protected Object	RestoreScrollValues(Object domElement) Ovverridden to do nothing since it is not needed for menus
protected Object	SaveScrollValues(Object domElement) Ovverridden to do nothing since it is not needed for menus
protected Boolean	ShouldHideOnClip() Returns false as menu popups do not close on clip.
private Number	_visitChildrenForMenu(AdfUIComponent component) Callback used by _getFirstMenuItem to visitChildren on the component.

Methods inherited from oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfDhtmlPopupWindow

addOpenedHandler, AnimateOpening, AnimateUsingWrapper, AnimationComplete, autoSize, cancel, destroy, DoShow, FocusOnFirstElement, GetAnimationDuration, getContent, GetFocusOnOpen, getLaunchSourceId, GetMaxWidth, getPopupClientId, GetPositionManagerIndex, getZorderScope, HandleEscapeKey, HandleKeyNavigation, HasShadow, hide, ImmediateZorderRegistration, isAnimating, isVisible, OpenedPopup, Position, setCloseHandler, setCloseHandlerParam, setContent, SetFocusOnOpen, setRestoreFocusId, show, WrapContent

Methods inherited from oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfAbstractFloatingElement

CreateTable, getAlignElement, getAlignPosition, getElement, GetFirstFormId, GetFloatingType, getHeight, getLeft, getShadowAnchor, getTop, getWidth, raiseToFront, setAlignElement, setAlignPosition, setElement, setLeft, setPosition, setShadowAnchor, setTop

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

setShadowAnchor

public Object setShadowAnchor

Constructor Detail

AdfDhtmlPopupMenu

public AdfDhtmlPopupMenu()

A popup window that is used to diplay components with a menu display style

Method Detail

activate

public Object activate()

Focus on the first element. No need to autosize, as this is done automatically by AdfDhtmlPopupWindow when a resize is detected. This is called by the AdfDhtmlMenuPeer when a detached menu initially becoming detached. A similar approach is found in AdfDhtmlSimpleFloat.

Return:

Object

CreateDomElement

protected HTMLElement CreateDomElement()

Create and initialize the html.

Return:

HTMLElement - the root dom element of this popup.

Overrides:

AdfDhtmlPopupWindow.CreateDomElement()

CreateShadow

protected Object CreateShadow(Boolean afterAnimation)

Creates the shadow for this popup window

Parameters:

afterAnimation

-

flag indicates that we want to create the shadow after animation

Return:

Object

Overrides:

AdfDhtmlPopupWindow.CreateShadow(Boolean)

DoResizeNotifyDom

protected Object DoResizeNotifyDom(Object content)

For now there is no use case for geometry management of the menu content.

Parameters:

content

Return:

Object

Overrides:

AdfDhtmlPopupWindow.DoResizeNotifyDom(Object)

GetAnimationDurationSkinProperty

protected Object GetAnimationDurationSkinProperty()

Returns the skin property for animation duriation

Return:

Object

Overrides:

AdfDhtmlPopupWindow.GetAnimationDurationSkinProperty(Object)

GetContentParent

protected HTMLElement GetContentParent()

Gets the dom element that is the parent of the popup's content.

Return:

HTMLElement - contentParentElement the parent of the content

Overrides:

AdfDhtmlPopupWindow.GetContentParent()

_getFirstMenuItem

private Object _getFirstMenuItem(AdfUIComponent component)

Inspects the content of the AdfRichMenu and returns the first menu item - commandMenuItem (AdfRichCommandMenuItem component), goMenuItem (AdfRichGoMenuItem component), or submenu (AdfRichMenu component).

Parameters:

component

-

root menu component

Return:

Object - menu item component for the first child (or null)

GetFocusContent

protected HTMLElement GetFocusContent()

Returns the first command menu item, submenu, or dom node of the floating element.

Return:

HTMLElement - content node area

Overrides:

AdfDhtmlPopupWindow.GetFocusContent()

GetLaunchSourceElement

protected Object GetLaunchSourceElement()

Get the launch source element (if available), which is the last menuBar item that had focus. This method is called during AdfDhtmlPopupWindow hide/_restoreFocus

Return:

Object

Overrides:

AdfDhtmlPopupWindow.GetLaunchSourceElement()

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

Overrides:

AdfDhtmlPopupWindow.InitClass()

RestoreScrollValues

protected Object RestoreScrollValues(Object domElement)

Ovverridden to do nothing since it is not needed for menus

Parameters:

domElement

Return:

Object

Overrides:

AdfDhtmlPopupWindow.RestoreScrollValues(HTMLElement)

SaveScrollValues

protected Object SaveScrollValues(Object domElement)

Ovverridden to do nothing since it is not needed for menus

Parameters:

domElement

Return:

Object

Overrides:

AdfDhtmlPopupWindow.SaveScrollValues(HTMLElement)

ShouldHideOnClip

protected Boolean ShouldHideOnClip()

Returns false as menu popups do not close on clip.

Return:

Boolean - if popup window should hide on clip

Overrides:

AdfDhtmlPopupWindow.ShouldHideOnClip()

_visitChildrenForMenu

private Number _visitChildrenForMenu(AdfUIComponent component)

Callback used by _getFirstMenuItem to visitChildren on the component. The callback looks for the first AdfRichCommandMenuItem, AdfRichGoMenuItem, or AdfRichMenu. If the first child is a command menu item, go menu item, or submenu, it is assigned to a temporary private variable.

Parameters:

component

-

child component visited

Return:

Number - returns a value of 2 indicating traversal has finished; otherwise, a value of 1

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