JavaScript API Reference for Oracle ADF Faces

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

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

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.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelGridLayoutPeer

public class AdfDhtmlPanelGridLayoutPeer
extends AdfRichUIPeer

Field Summary

Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, CreateSubId, DISABLED_STYLECLASS, DRAG_READY_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlPanelGridLayoutPeer()

Method Summary

protected Object	ChildVisibilityChanged(AdfUIComponent childComponent, HTMLElement childDomElement, boolean childVisible) Resize notification callback - we perform geometry management here.
protected Object	ComponentInlineStyleChanged(AdfUIComponent component, HTMLElement domElement, string newValue, string oldValue) Optimized setter for the INLINE_STYLE attribute.
protected Object	ComponentRemoved(AdfUIComponent component) Override to unregister descendant resize notification.
private ?string	_getAttribute(AdfAgent agent, HTMLElement element, string name, ?string defaultValue) Gets the specified attribute from the given element
private string	_getColumns(AdfUIComponent component) Gets the private property that describes the column widths.
private Object	_getFirstEdge(Array lineSizes, number lineNumber) Gets the distance from the start/top of the panelGridLayout to the start/top side of the specified cell.
private Object	_getLastEdge(Array lineSizes, number lineNumber) Gets the distance from the end/bottom of the panelGridLayout to the end/bottom side of the specified cell.
private string	_getRows(AdfUIComponent component) Gets the private property that describes the row heights.
protected static Object	InitSubclass() Register optimized setter/getter for SOURCE attribute.
private boolean	_isChild(HTMLElement domNode) Tests whether the specified node is a child of the panelGridLayout.
public Object	needsChildVisibilityChanges(AdfUIComponent component) Override to indicate interest in child visibility change notifications.
public boolean	needsResizeNotify(AdfUIComponent component) Override to indicate interest in resize notifications.
private boolean	_repositionPanes(?number givenWidth, ?number givenHeight) Position the panes in the grid layout.
protected Object	ResizeNotify(number oldWidth, number oldHeight, number newWidth, number newHeight) Resize notification callback - we perform geometry management here.
private Array.<Object>	_resolveSizes(Array lineSizes, Object lastLineNumber, HTMLElement rootElement, Array.<Object> childData, string lineKey, string lineSpanKey, string lineAlignKey, string clientSizeKey, Object clientSize) Resolves the sizes for the columns or rows.

Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, BindToComponent, cancelAllPopups, cancelPopup, clearDragReadyState, ClearDragReadyState, clearDragSourceState, ClearDragSourceState, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, domReplaceNotify, DomReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, InitClass, InitDomElement, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren

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

getDefaultDragRecognizer, getParentPeer, Init, initiateDrag, isVisible

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

Constructor Detail

AdfDhtmlPanelGridLayoutPeer

public AdfDhtmlPanelGridLayoutPeer()

Method Detail

ChildVisibilityChanged

protected Object ChildVisibilityChanged(AdfUIComponent childComponent,
HTMLElement childDomElement,
boolean childVisible)

Resize notification callback - we perform geometry management here.

Parameters:

childComponent	-	the child component
childDomElement	-	the root element of the child
childVisible	-	the new visibility state of the child

Return:

Object

Overrides:

AdfRichUIPeer.ChildVisibilityChanged(Object, Object, Object)

ComponentInlineStyleChanged

protected Object ComponentInlineStyleChanged(AdfUIComponent component,
HTMLElement domElement,
string newValue,
string oldValue)

Optimized setter for the INLINE_STYLE attribute.

Parameters:

component	-	the panelGridLayout component
domElement	-	the root element of the panelGridLayout
newValue	-	the new inlineStyle value
oldValue	-	the old inlineStyle value

Return:

Object

Overrides:

AdfRichUIPeer.ComponentInlineStyleChanged(Object, Object, Object, Object)

ComponentRemoved

protected Object ComponentRemoved(AdfUIComponent component)

Override to unregister descendant resize notification.

Parameters:

component

-

the panelGridLayout component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

_getAttribute

private ?string _getAttribute(AdfAgent agent,
HTMLElement element,
string name,
?string defaultValue)

Gets the specified attribute from the given element

Parameters:

agent	-	the agent
element	-	the element whose attribute is requested
name	-	the name of the attribute
defaultValue	-	the default value to return if the requested attribute value was null

Return:

?string - the requested attribute value

_getColumns

private string _getColumns(AdfUIComponent component)

Gets the private property that describes the column widths.

Parameters:

component

-

the panelGridLayout component

Return:

string - the private property that describes the column widths

_getFirstEdge

private Object _getFirstEdge(Array lineSizes,
number lineNumber)

Gets the distance from the start/top of the panelGridLayout to the start/top side of the specified cell.

Parameters:

lineSizes	-	the column or row sizes as pixel numbers
lineNumber	-	the column or row number (not index) whose start/top side we want to get

Return:

Object - the pixel value for the start/top side

_getLastEdge

private Object _getLastEdge(Array lineSizes,
number lineNumber)

Gets the distance from the end/bottom of the panelGridLayout to the end/bottom side of the specified cell.

Parameters:

lineSizes	-	the column or row sizes as pixel numbers
lineNumber	-	the column or row number (not index) whose end/bottom side we want to get

Return:

Object - the pixel value for the end/bottom side

_getRows

private string _getRows(AdfUIComponent component)

Gets the private property that describes the row heights.

Parameters:

component

-

the panelGridLayout component

Return:

string - the private property that describes the row heights

InitSubclass

protected static Object InitSubclass()

Register optimized setter/getter for SOURCE attribute.

Return:

Object

_isChild

private boolean _isChild(HTMLElement domNode)

Tests whether the specified node is a child of the panelGridLayout.

Parameters:

domNode

-

the element to test

Return:

boolean - childVisible the new visibility state of the child

needsChildVisibilityChanges

public Object needsChildVisibilityChanges(AdfUIComponent component)

Override to indicate interest in child visibility change notifications.

Parameters:

component

-

the panelGridLayout component

Return:

Object

Overrides:

AdfRichUIPeer.needsChildVisibilityChanges(AdfUIComponent)

needsResizeNotify

public boolean needsResizeNotify(AdfUIComponent component)

Override to indicate interest in resize notifications.

Parameters:

component

-

the panelGridLayout component

Return:

boolean - true if it needs resize notify

Overrides:

AdfUIPeer.needsResizeNotify(Object)

_repositionPanes

private boolean _repositionPanes(?number givenWidth,
?number givenHeight)

Position the panes in the grid layout.

Parameters:

givenWidth	-	the given width or null
givenHeight	-	the given height or null

Return:

boolean - true if this grid layout needs to listen for descendant resize notifications

ResizeNotify

protected Object ResizeNotify(number oldWidth,
number oldHeight,
number newWidth,
number newHeight)

Resize notification callback - we perform geometry management here.

Parameters:

oldWidth	-	the oldWidth
oldHeight	-	the oldHeight
newWidth	-	the newWidth
newHeight	-	the newHeight

Return:

Object

Overrides:

AdfUIPeer.resizeNotify(Object, Object, Object, Object, Object)

_resolveSizes

private Array.<Object> _resolveSizes(Array lineSizes,
Object lastLineNumber,
HTMLElement rootElement,
Array.<Object> childData,
string lineKey,
string lineSpanKey,
string lineAlignKey,
string clientSizeKey,
Object clientSize)

Resolves the sizes for the columns or rows.

Parameters:

lineSizes	-	the raw column or row sizes as strings from the renderer
lastLineNumber
rootElement	-	the root element of the panelGridLayout
childData	-	array of objects containing information about each cell
lineKey	-	"col" or "row"
lineSpanKey	-	"cspan" or "rspan"
lineAlignKey	-	"halign" or "valign"
clientSizeKey	-	"clientWidth" or "clientHeight"
clientSize

Return:

Array.<Object> - an array with 2 values: (1) the total of the non-percent sizes, (2) caresAboutDescendantResizeNotifications

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