JavaScript API Reference for Oracle ADF Faces

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

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

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.AdfDhtmlShowDisclosurePeer

Direct Known Subclasses:

AdfDhtmlShowDetailItemPeer, AdfDhtmlShowDetailPeer

public class AdfDhtmlShowDisclosurePeer
extends AdfRichUIPeer

Base class for show detail peers, similar in spirit to ShowDisclosureRenderer

Field Summary

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

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_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

AdfDhtmlShowDisclosurePeer() Base class for show detail peers, similar in spirit to ShowDisclosureRenderer

Method Summary

protected Object	BindToComponent(AdfUIComponent component, HTMLElement rootElement) Binds the component to this peer instance.
protected Object	ComponentDisclosedChanged(Object component, Object domElement, Object newValue, Object oldValue) Handle component disclosure property change.
protected Object	ComponentRemoved(Object component) Clean up the peer because it's component is being removed.
protected Boolean	DisclosurePropagatesToServer(Boolean isExpanded, Boolean isDirty) Provides a means for sub-classes to determine if a disclosure event must propogate to the server or not.
protected Object	HandleComponentDisclosure(Object componentEvent)
protected Object	HandleComponentValueChange(Object componentEvent)
protected Object	InitDirtyTracking(Object component, Object domElement) Function that sets up the ability to track value changes to sub-components.
protected static Object	InitSubclass() Registers component property change handlers for diclosure event
public Object	queueDisclosureEvent(Boolean isExpanded, Boolean partial, AdfUIShowDetail disclosureCounterpart) Convenience function for queueing a disclosure event for this peer's component.
protected Object	RemoveDirtyTracking(Object component, Object domElement) Function that cleans up any work done by the InitDirtyTracking function.

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

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, cancelAllPopups, cancelPopup, ChildVisibilityChanged, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, 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, Init, InitClass, InitDomElement, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren

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

getDefaultDragRecognizer, getParentPeer, initiateDrag, isVisible, needsResizeNotify

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

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

Field Detail

Constructor Detail

AdfDhtmlShowDisclosurePeer

public AdfDhtmlShowDisclosurePeer()

Base class for show detail peers, similar in spirit to ShowDisclosureRenderer

Method Detail

BindToComponent

protected Object BindToComponent(AdfUIComponent component,
HTMLElement rootElement)

Binds the component to this peer instance.

Parameters:

component	-	the component to bind
rootElement	-	the root DOM element of this peer

Return:

Object

Overrides:

AdfRichUIPeer.BindToComponent(Object, Object)

ComponentDisclosedChanged

protected Object ComponentDisclosedChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)

Handle component disclosure property change. Queues a disclosure event.

Parameters:

component
domElement
newValue
oldValue

Return:

Object

ComponentRemoved

protected Object ComponentRemoved(Object component)

Clean up the peer because it's component is being removed.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

DisclosurePropagatesToServer

protected Boolean DisclosurePropagatesToServer(Boolean isExpanded,
Boolean isDirty)

Provides a means for sub-classes to determine if a disclosure event must propogate to the server or not. By returning false, the peer is stating that it will handle the disclosure on the client. The default implementation will allow the disclosure to be performed client side only for collapsing if there are no server disclosure listeners and the component is not dirty and dirty tracking was initialized.

Parameters:

isExpanded	-	true if the new disclosed state is true, false othewise
isDirty	-	true if value changes were detected in this component

Return:

Boolean - false to handle the disclosure locally, else the event will be broadcast to the server

HandleComponentDisclosure

protected Object HandleComponentDisclosure(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentValueChange

protected Object HandleComponentValueChange(Object componentEvent)

Parameters:

componentEvent

Return:

Object

InitDirtyTracking

protected Object InitDirtyTracking(Object component,
Object domElement)

Function that sets up the ability to track value changes to sub-components. Sub-classes may override to disable this functionality. It is recommended that this be called from the BindToComponent function of the peer for overridden classes.

Parameters:

component
domElement

Return:

Object

InitSubclass

protected static Object InitSubclass()

Registers component property change handlers for diclosure event

Return:

Object

queueDisclosureEvent

public Object queueDisclosureEvent(Boolean isExpanded,
Boolean partial,
AdfUIShowDetail disclosureCounterpart)

Convenience function for queueing a disclosure event for this peer's component.

Parameters:

isExpanded	-	true if the new disclosed state is true, false othewise
partial	-	true if the even uses partial submit, false otherwise
disclosureCounterpart	-	An optional counterpart component used by components that change the disclosure state of 2 components at the same time. If this component is provided and if isExpanded is set to false, the isExpanded being set to false will not be sent to the server and instead a new AdfDisclosureEvent will be kicked off on the client for the showOneCounterPart component being set to true.

Return:

Object

RemoveDirtyTracking

protected Object RemoveDirtyTracking(Object component,
Object domElement)

Function that cleans up any work done by the InitDirtyTracking function.

Parameters:

component
domElement

Return:

Object

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