JavaScript API Reference for Oracle ADF Faces

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

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.AdfDhtmlValuePeer
                           |
                           +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
                                 |
                                 +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlSelectManyPeer
                                       |
                                       +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlSelectManyShuttlePeer

public class AdfDhtmlSelectManyShuttlePeer
extends AdfDhtmlSelectManyPeer

_BOTTOM_ID

private static Object _BOTTOM_ID

_BOTTOM_ID_ATTR_NAME

private static Object _BOTTOM_ID_ATTR_NAME

_BUTCON_KEYS

private static Object _BUTCON_KEYS

_DISABLED_STYLE_CLASS

private static Object _DISABLED_STYLE_CLASS

_DOWN_ID

private static Object _DOWN_ID

_DOWN_ID_ATTR_NAME

private static Object _DOWN_ID_ATTR_NAME

_HREF

private static Object _HREF

_LAZY_ATTR

private static Object _LAZY_ATTR

_LEAD_ALL_ID

private static Object _LEAD_ALL_ID

_LEAD_DESC

private static Object _LEAD_DESC

_LEAD_UL

private static Object _LEAD_UL

_LEAD_UL_ID_EXPANDO

private static Object _LEAD_UL_ID_EXPANDO

_MOVE_DIV

private static Object _MOVE_DIV

_MOVE_DIV_ID_EXPANDO

private static Object _MOVE_DIV_ID_EXPANDO

_MOVE_ID

private static Object _MOVE_ID

_MOVE_ID_ATTR_NAME

private static Object _MOVE_ID_ATTR_NAME

_MOVEALL_ID

private static Object _MOVEALL_ID

_MOVEALL_ID_ATTR_NAME

private static Object _MOVEALL_ID_ATTR_NAME

_ONCLICK

private static Object _ONCLICK

_REMOVE_ID

private static Object _REMOVE_ID

_REMOVE_ID_ATTR_NAME

private static Object _REMOVE_ID_ATTR_NAME

_REMOVEALL_ID

private static Object _REMOVEALL_ID

_REMOVEALL_ID_ATTR_NAME

private static Object _REMOVEALL_ID_ATTR_NAME

_REORDER_DIV

private static Object _REORDER_DIV

_REORDER_DIV_ID_EXPANDO

private static Object _REORDER_DIV_ID_EXPANDO

_RETURN_FALSE

private static Object _RETURN_FALSE

_SELECT_VALUES

private static Object _SELECT_VALUES

_SUB_ID_MAP

private static Object _SUB_ID_MAP

selectManyShuttle component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [label --> label] - selectManyShuttle/selectOrderShuttle label 2. [content --> content] - selectManyShuttle/selectOrderShuttle content 3. [leadHeader] - selectManyShuttle/selectOrderShuttle lead section header 4. [trailHeader] - selectManyShuttle/selectOrderShuttle trailing section header 5. [leadLegend] - selectManyShuttle/selectOrderShuttle lead section legend (present in screen reader mode) 6. [trailLegend] - selectManyShuttle/selectOrderShuttle trailing section legend (present in screen reader mode) 7. [leadUl --> leadUl] - selectManyShuttle/selectOrderShuttle leftside list 8. [trailUl --> trailUl] - selectManyShuttle/selectOrderShuttle rightside list 9. [move --> move] - selectManyShuttle/selectOrderShuttle move arrow 10. [moveall --> moveall] - selectManyShuttle/selectOrderShuttle move all arrow 11. [remove --> remove] - selectManyShuttle/selectOrderShuttle remove arrow 12. [removeall --> removeall] - selectManyShuttle/selectOrderShuttle remove all arrow 13. [move-top --> move-top] - selectManyShuttle/selectOrderShuttle move to top arrow 14. [move-up --> move-up] - selectManyShuttle/selectOrderShuttle move up arrow 15. [move-down --> move-down] - selectManyShuttle/selectOrderShuttle move down arrow 16. [move-bottom --> move-bottom] - selectManyShuttle/selectOrderShuttle move to bottom arrow 17. [item[(value)] --> item] - selectManyShuttle/selectOrderShuttle item (selectItem, by rendered value)

_TABINDEX

private static Object _TABINDEX

_TOP_ID

private static Object _TOP_ID

_TOP_ID_ATTR_NAME

private static Object _TOP_ID_ATTR_NAME

_TRAIL_DESC

private static Object _TRAIL_DESC

_TRAIL_ITEMS

private static Object _TRAIL_ITEMS

_TRAIL_ITEMS_ID_EXPANDO

private static Object _TRAIL_ITEMS_ID_EXPANDO

_TRAIL_UL

private static Object _TRAIL_UL

_TRAIL_UL_ID_EXPANDO

private static Object _TRAIL_UL_ID_EXPANDO

_UP_ID

private static Object _UP_ID

_UP_ID_ATTR_NAME

private static Object _UP_ID_ATTR_NAME

AdfDhtmlSelectManyShuttlePeer

public AdfDhtmlSelectManyShuttlePeer()

_checkButconDisabledClassName

private Object _checkButconDisabledClassName(Object nodeId)

Helper method to detect if button is disabled by looking at the DOM element class name.

Parameters:

nodeId

-

the client id of the button

Return:

Object - true if it has disabled classname and false otherwise

_checkTask

private Object _checkTask(Object node)

Checks the ID of the given HTML element regarding the move OR reorder task.

Parameters:

node

Return:

Object - the task

_clearDesc

private Object _clearDesc(Object side)

clears the description area for the given side.

Parameters:

side

-

the side (lead or trail)

Return:

Object

_clearDescs

private Object _clearDescs()

clears both description areas of the shuttle

Return:

Object

_createSubmitValueArray

private Object _createSubmitValueArray(Object runValidate)

Helper function to refill the hidden filed after each move/remove and reorder task.

Parameters:

runValidate

Return:

Object

_disableButcon

private Object _disableButcon(Object disable,
                              Object buttonId,
                              Object attrName,
                              Object canBeVertical,
                              Object needsRTL)

Helper function that loads a HTML element (buttonId) and calls AdfDomUtils.addOrRemoveCSSClassName to add or remove the CSS disabled state.

Parameters:

disable	-	should we apply the disabled style class?
buttonId	-	the id of the button, which we want to manipluate
attrName
canBeVertical
needsRTL

Return:

Object

_disableButtons

private Object _disableButtons(Object domElement)

disables the move/moveall buttons, when leading container is empty and does the same with remove/removeall, when the trailing container is empty.

Parameters:

domElement

Return:

Object

_endsWith

private Object _endsWith(Object value,
                         Object suffix)

String helper function to check if the given value ends with the given suffix

Parameters:

value	-	the value
suffix	-	the suffix

Return:

Object - does the value contain the suffix

Focus

protected Object Focus()

Override of AdfRichUIPeer.Focus. The first tab stop could be the help icon or context facet so we want to move to the content.

Return:

Object

Overrides:

AdfUIPeer.focus(Object)

_getAnchor

private Object _getAnchor(Object node)

Get the anchor, used by the move/reorder buttons. When using Icons, there is another DOM structure, so that we need to get the A element.

Parameters:

node

Return:

Object

_getButconParentContainer

private Object _getButconParentContainer(Object domElement,
                                         Object node)

Returns the parent container of the given button node.

Parameters:

domElement	-	the root dom element
node	-	the HTML node to check for the parent container

Return:

Object

GetCheckboxByEventTarget

protected Object GetCheckboxByEventTarget(Object element,
                                          Object componentEvent)

Helper function the get a input checkbox element, that is nested inside an

• <LABEL/>
• structure.

Parameters:

element
componentEvent

Return:

Object

Overrides:

AdfDhtmlSelectManyPeer.GetCheckboxByEventTarget(Object, Object)

GetCheckboxes

protected Object GetCheckboxes(Object component,
                               Object domElement,
                               Object containerName)

Helper to get an array of input checkbox elements from a given ul HTML element (trail or lead). Overrides the GetCheckboxes from the AdfDhtmlSelectManyShuttlePeer

Parameters:

component
domElement	-	the root dom element
containerName	-	the name of the container

Return:

Object

Overrides:

AdfDhtmlSelectManyPeer.GetCheckboxes(Object, Object, Object)

_getCheckedItemValues

private Object _getCheckedItemValues(Object side)

Returns an array, containing the values of all selected items on a given side.

Parameters:

side

-

the side to query for the values of the selected items

Return:

Object

_getClearContainer

private HTMLElement _getClearContainer(Object containerName)

Helper function to clear the items container. Used for the click on moveAll or removeAll. The function returns the empty container.

Parameters:

containerName

-

the name of the container

Return:

HTMLElement - the empty UL container

GetComponentSelectItems

protected Object GetComponentSelectItems(Object component,
                                         Object domElement)

Method returns an array of AdfSelectItem objects, which are associated with this peer.

Parameters:

component	-	Component that this peer will be associated with
domElement	-	Root DOM element of this peer

Return:

Object - selectItem array

Overrides:

AdfDhtmlSelectManyPeer.GetComponentSelectItems(Object, Object)

_getContainer

private Object _getContainer(Object domElement,
                             Object containerName)

Helper to get the container for the select items, a HTML UL element. The function requires the usage of a name to identify the lead/trail side.

Parameters:

domElement	-	the root dom element
containerName	-	the name of the container

Return:

Object

_getDescBox

private Object _getDescBox(Object side)

Convenience method for getting the desired description area

Parameters:

side

-

the side (lead or trail)

Return:

Object

_getDescSide

private Object _getDescSide(Object target)

Parameters:

target

Return:

Object

_getElementFromContainerByValue

private HTMLElement _getElementFromContainerByValue(Object containerName,
                                                    Object value)

Helper method to get a HTML element from a given container (specified by its name), based on the given value

Parameters:

containerName	-	the name of the container
value	-	the value what the HTML of the HTML element in question

Return:

HTMLElement - an HTML element that has the particular value

_getFirstEnabledButcon

private Object _getFirstEnabledButcon(Object nodeIds,
                                      Object checkIndex,
                                      Object defaultNode)

Helper method to recursively check the array of buttons id for enabled butcon anchor element. This method will do recursive calls to check all elements in the input array.

Parameters:

nodeIds	-	an array of button anchor ids to check.
checkIndex	-	index of array need to be checked.
defaultNode	-	is the default node if all nodes are not good

Return:

Object

_getFirstEnabledCheckbox

private Object _getFirstEnabledCheckbox(Object containerName)

Returns the first enabled checkbox element from the specified container.

Parameters:

containerName

-

the container name, from which we want the first enabled checkbox.

Return:

Object

_getHiddenField

private Object _getHiddenField()

get's the hidden field, which store's the shuttle state.

Return:

Object

GetInlineEditor

protected Object GetInlineEditor(Event event)

Override to return an inline editor that edits the component's label property

Parameters:

event

-

DOM Event that triggered the inline edit

Return:

Object

Overrides:

AdfRichUIPeer.getInlineEditor(AdfUIComponent, Object)

_getNextButcon

private Object _getNextButcon(Object domElement,
                              Object parentContainerName,
                              Object source)

Returns the next move or reorder butcon

Parameters:

domElement	-	the DOM root element
parentContainerName
source	-	the source of the up or down keydown event

Return:

Object - next available butcon or current

GetNoteWindowAlignmentNode

protected Object GetNoteWindowAlignmentNode(Object component,
                                            Object rootNode)

Returns the node for which to align the note help window

Parameters:

component
rootNode

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.GetNoteWindowAlignmentNode(Object, Object)

_getParentContainer

private Object _getParentContainer(Object domElement,
                                   Object node)

Returns the parent lead/trail container of the given node.

Parameters:

domElement	-	the root dom element
node	-	the HTML node to check for the parent container

Return:

Object

_getPreviousButcon

private Object _getPreviousButcon(Object domElement,
                                  Object parentContainerName,
                                  Object source)

Returns the previous move or reorder butcon

Parameters:

domElement	-	the DOM root element
parentContainerName
source	-	the source of the up or down keydown event

Return:

Object - next available butcon or current

_getSelectedIndices

private Object _getSelectedIndices(Object container)

private helper that returns an Array which contains the indices of the selected checkboxes.

Parameters:

container

Return:

Object

_getSelectItemCount

private Object _getSelectItemCount(Object container,
                                   Object checked)

Function that returns the number of SelectItems of a particular container. When the checked parameter is true, only the number of selected items are counted, otherwise all enabled items of the container

Parameters:

container	-	the leading or trailing container element
checked	-	should this function return the number of selected items

Return:

Object

GetSubIdDomElement

protected Object GetSubIdDomElement(Object subElementId)

Returns the DOM element identified by the passed in subId.

Parameters:

subElementId

Return:

Object - the DOM element

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

GetSubmittedValue

protected Object GetSubmittedValue(Object component,
                                   Object domElement)

overwritten GetSubmittedValue fuction

Parameters:

component
domElement

Return:

Object

See also:

AdfDhtmlEditableValuePeer

Overrides:

AdfDhtmlEditableValuePeer.GetSubmittedValue(Object, Object)

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

A component click event event handler. This function performs different checks. It checks if an item was selected and display the description, when there is one (and the description area is enabled). It checks if one of the move/remove buttons where clicked, to do the (re)move. Or it performs the reordering, when one of the selectOrderShuttle's reorder buttons are clicked.

Parameters:

componentEvent

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.HandleComponentClick(Object)

HandleComponentDblClick

protected Object HandleComponentDblClick(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentFocus

protected Object HandleComponentFocus(Object componentEvent)

Parameters:

componentEvent

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.HandleComponentFocus(Object)

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

A component key down event handler. Used to set the tab stop to the next/previous checkbox, when using ARROW KEYS. Each container can contain one checkbox to be a tab stop. This is a requirement to avoid to many "tab stops" per container.

Parameters:

componentEvent

Return:

Object

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

A component mouse down event handler. Used to set the tab stop of the checkbox to the last one clicked on (per container).

Parameters:

componentEvent

Return:

Object

_initLazyLoad

private Object _initLazyLoad(Object domElement)

Parameters:

domElement

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

Overrides:

AdfDhtmlValuePeer.InitSubclass()

_isReorderOnly

private Object _isReorderOnly()

Helper function that checks if we are current running in reorderOnly mode. That is true, when there isn't a SelectOrderShuttle or a SelectOrderShuttle that is not reorderOnly.

Return:

Object

_lazyInitButtons

private Object _lazyInitButtons()

A function to stash the move/remove button IDs on the rootDomElement. This task isn't done in InitDomElement, because of performance reasons. This function is only called once, when we first hit the "component focus event event handler". To ensure this, the function stashes a state on the rootDomElement, that indicates this function has been called.

Return:

Object

LazyInitialize

protected Object LazyInitialize(Object component,
                                Object domElement)

Initialize the associated domElement when the peer is created. we setup javascript event handlers at this time.

Parameters:

component	-	Component that this peer will be associated with
domElement	-	Root DOM element of this peer

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.LazyInitialize(Object, Object)

_manageMoveButtons

private Object _manageMoveButtons(Object target)

Helper function that manages the state of the move/remove buttons. As per spec, a move/remove button should only be enabled, when an item (lead/trail) is selected.

Parameters:

target

Return:

Object

_manageReorderButtons

private Object _manageReorderButtons()

Helper function that manages the state of the reorder buttons. As per spec, all reorder buttons should only be enabled, when an item of the trail container is selected.

Return:

Object

_move

private Object _move(Object fromUL,
                     Object toUL,
                     Object all)

A function that moves the selceted items (or all) from one container to another container. The nested structure looks like: <xmp>

• foo</xmp>

Parameters:

fromUL	-	the container (UL HTML element), from which the elements should be moved
toUL	-	the container (UL HTML element), to which the elements should be moved
all	-	do we move/remove all items ?

Return:

Object

_reorder

private Object _reorder(Object mode)

util for walking through the partial dome dom (on the trail side) get's the selected items and reorders them

Parameters:

mode

-

the mode for the reordering (up, top, down or bottom)

Return:

Object

_saveValuesOnElement

private Object _saveValuesOnElement(Object domElement)

Function called on initDom to save all select items values (from trail and lead) on the root dom element.

Parameters:

domElement

-

the root dom element

Return:

Object

_setCurrentTabStop

private Object _setCurrentTabStop(Object rootElement,
                                  Object newTabStop,
                                  Object select)

Change the active tab stop.

Parameters:

rootElement
newTabStop
select

Return:

Object

SetDisplayValue

protected Object SetDisplayValue(Object component,
                                 Object domElement,
                                 Object newValue)

overwritten SetDisplayValue fuction

Parameters:

component
domElement
newValue

Return:

Object

See also:

AdfDhtmlEditableValuePeer

Overrides:

AdfDhtmlValuePeer.SetDisplayValue(Object, Object, Object)

_showDesc

private Object _showDesc(Object target)

Helper method for showing the description value in the textarea for the current side (lead or trail).

Parameters:

target

-

clicked input element

Return:

Object

_smartMove

private Object _smartMove(Object attrValue)

Controller for the real move method. Called by the onclick handler, to feed move with the right informations.

Parameters:

attrValue

Return:

Object

_unselectAll

private Object _unselectAll(Object container)

Parameters:

container

Return:

Object

_updateClickedCheckbox

private Object _updateClickedCheckbox(Object target,
                                      Object componentEvent)

Parameters:

target
componentEvent

Return:

Object

Validate

protected Object Validate(Object component,
                          Object submittedValue)

Parameters:

component
submittedValue

Return:

Object

Overrides:

AdfDhtmlEditableValuePeer.Validate(Object, Object)