JavaScript API Reference for Oracle ADF Faces

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

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

Direct Known Subclasses:

AdfDhtmlMaximizePeer, AdfDhtmlShowDisclosurePeer

public class AdfDhtmlTogglePeer
extends AdfRichUIPeer

_COPIED_PROPERTIES

private static Object _COPIED_PROPERTIES

QueueClientEvent

protected Object QueueClientEvent

Queues the client event for the component {boolean} toggled The new state of the component {boolean} isPartial ?true if this is a partial event

_STYLE_CLASS_PROPERTIES

private static Object _STYLE_CLASS_PROPERTIES

_TRANSLATION_PROPERTIES

private static Object _TRANSLATION_PROPERTIES

AdfDhtmlTogglePeer

public AdfDhtmlTogglePeer()

Base class for peers that toggle an icon state to send events

ApplyTitle

protected Object ApplyTitle(Object titleText)

Parameters:

titleText

Return:

Object

Config

protected static Object Config(Object subclass,
                               Object config)

Copies the specified properties onto this class's prototype, transforming the style class and translated strings to their client-side values

Parameters:

subclass
config

Return:

Object

EventPropagatesToServer

protected Object EventPropagatesToServer(Object isExpanded)

Parameters:

isExpanded

Return:

Object

GetButtonElement

protected Object GetButtonElement()

Return:

Object

GetButtonImageElement

protected Object GetButtonImageElement()

Return:

Object

getIconURL

public Object getIconURL(Object state)

Returns the icon to use for the current state

Parameters:

state

Return:

Object

GetNewValueFromEvent

protected Object GetNewValueFromEvent(Object componentEvent)

Given the component-specific toggling event, return the new value of the component. Peers with events that include the new value in the event should override this function to extract the new value from the event. The default implementation assumes that the event simply toggles the component value.

Parameters:

componentEvent

Return:

Object

GetPropertyValue

protected Object GetPropertyValue(Object component)

Returns the current value of the property that the TogglePeer uses

Parameters:

component

Return:

Object

GetTitle

protected Object GetTitle()

Return:

Object

HandleClientSideToggle

protected boolean HandleClientSideToggle(Boolean toggled)

Client side optimized toggle function

Parameters:

toggled

-

true if the new state is toggled

Return:

boolean - True if the peer handled the property change locally

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Handles component-level clicks

Parameters:

componentEvent

Return:

Object

HandleComponentKeyUp

protected Object HandleComponentKeyUp(AdfUIInputEvent componentEvent)

Handles component-level key ups.

Parameters:

componentEvent

-

the key up component event

Return:

Object

HandleToggleEventImpl

protected static boolean HandleToggleEventImpl(Object componentEvent)

Implementation of the toggling the property of whatever property the peer subclass uses. For Maximize subclasses, this is the maximize property, for disclosure subclasses, the disclosed property.

Parameters:

componentEvent

Return:

boolean - True if the peer handled the property change locally

InitSubclass

protected static Object InitSubclass(Object initializationState)

Registers component property change handlers for diclosure event

Parameters:

initializationState

Return:

Object

isEventForButton

public Object isEventForButton(Object nativeEvent)

Check to see if the native event applies to this component

Parameters:

nativeEvent

Return:

Object

QueueClientEvent

protected Object QueueClientEvent(boolean toggled,
                                  boolean= isPartial)

Queues the client event for the component

Parameters:

toggled	-	The new state of the component
isPartial	-	true if this is a partial event

Return:

Object

_queueClientEvent

private Object _queueClientEvent(Object nativeEvent,
                                 Object newToggleState)

Queues the disclosure event and cancels the native event

Parameters:

nativeEvent	-	the event object
newToggleState

Return:

Object

TogglePropertyChangedImpl

protected static Object TogglePropertyChangedImpl(Object component,
                                                  Object domElement,
                                                  Object newValue,
                                                  Object oldValue)

Handle component disclose or maximize property change. Queues a Maximize event.

Parameters:

component
domElement
newValue
oldValue

Return:

Object

UpdateButton

protected boolean UpdateButton(boolean toggled)

Updates the toggled component with the new toggle style and text

Parameters:

toggled

-

true if toggled

Return:

boolean - True if the peer was able to update the button locally