Component: ojCollapsible

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

Options


Sub-ID's

oj. ojCollapsible extends oj.baseComponent

Version:
  • 3.2.0
Since:
  • 0.6

JET Collapsible Component

Description: Themeable, WAI-ARIA-compliant collapsible with mouse and keyboard interactions for navigation.

A JET Collapsible can be created from any valid markup as long as the root element has at least two children: the first element for the header and the second element for the content.


<div id="collapsible">
  <h3>Header 1</h3>
  <p>Content 1</p>
</div>

Touch End User Information

Target Gesture Action
Header Tap Toggle disclosure state

Keyboard End User Information

Target Key Action
Header Space or Enter Toggle disclosure state.

Disabled items can receive keyboard focus, but do not allow any other interaction.

Reading direction

As with any JET component, in the unusual case that the directionality (LTR or RTL) changes post-init, the collapsible must be refresh()ed.

Pseudo-selectors

The :oj-collapsible pseudo-selector can be used in jQuery expressions to select JET Collapsible. For example:

$( ":oj-collapsible" ) // selects all JET Collapsible on the page
$myEventTarget.closest( ":oj-collapsible" ) // selects the closest ancestor that is a JET Collapsible

JET for jQuery UI developers

  1. JET Collapsible supports expandArea option: specifies where to click to toggle disclosure. Default is "disclosureIcon", however if a collapsible is inside an Accordion, default is "header"

Also, event names for all JET components are prefixed with "oj", instead of component-specific prefixes like "collapsible".

Initializer

.ojCollapsible()

Creates a JET Collapsible.
Source:
Examples

Initialize the collapsible with no options specified:

$( ".selector" ).ojCollapsible();

Initialize the collapsible with some options specified:

$( ".selector" ).ojCollapsible( { "expanded": true } );

Initialize the collapsible via the JET ojComponent binding:

<div id="collapsible" data-bind="ojComponent: { component: 'ojCollapsible', expanded: true}">

Options

contextMenu :Element|Array.<Element>|string|jQuery|NodeList

Identifies the JET Menu that the component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the specified JET Menu.

The value can be an HTML element, JQ selector, JQ object, NodeList, or array of elements. In all cases, the first indicated element is used.

To specify a JET context menu on a DOM element that is not a JET component, see the ojContextMenu binding.

To make the page semantically accurate from the outset, applications are encouraged to specify the context menu via the standard HTML5 syntax shown in the below example. When the component is initialized, the context menu thus specified will be set on the component.

There is no restriction on the order in which the JET Menu and the referencing component are initialized. However, when specifying the Menu via the HTML attribute, the referenced DOM element must be in the document at the time that the referencing component is initialized.

After create time, the contextMenu option should be set via this API, not by setting the DOM attribute.

The application can register a listener for the Menu's beforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

To help determine whether it's appropriate to cancel the launch or customize the menu, the beforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc and demos of the individual components for details. Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

Default Value:
  • null
Inherited From:
Source:
Examples

Initialize a JET component with a context menu:

// via recommended HTML5 syntax:
<div id="myComponent" contextmenu="myMenu" data-bind="ojComponent: { ... }>

// via JET initializer (less preferred) :
// Foo is the component, e.g., InputText, InputNumber, Select, etc.
$( ".selector" ).ojFoo({ "contextMenu": "#myMenu" });

Get or set the contextMenu option, after initialization:

// getter
// Foo is the component, e.g., InputText, InputNumber, Select, etc.
var menu = $( ".selector" ).ojFoo( "option", "contextMenu" );

// setter
// Foo is the component, e.g., InputText, InputNumber, Select, etc.
$( ".selector" ).ojFoo( "option", "contextMenu", ".my-marker-class" );

Set a JET context menu on an ordinary HTML element:

<a href="#" id="myAnchor" contextmenu="myMenu" data-bind="ojContextMenu: {}">Some text

disabled :boolean|null

Disables the collapsible if set to true.
Default Value:
  • false
Source:
Examples

Initialize the collapsible with the disabled option specified:

$( ".selector" ).ojCollapsible( { "disabled": true } );

Get or set the disabled option, after initialization:

// getter
var disabled = $( ".selector" ).ojCollapsible( "option", "disabled" );

// setter
$( ".selector" ).ojCollapsible( "option", "disabled", true );

expandArea :string

Where in the header to click to toggle disclosure. Valid values: disclosureIcon or header
Default Value:
  • "header"
Source:
Examples

Initialize the collapsible with the expandArea option specified:

$( ".selector" ).ojCollapsible( { "expandArea": "disclosureIcon" } );

Get or set the expandArea option, after initialization:

// getter
var expandArea = $( ".selector" ).ojCollapsible( "option", "expandArea" );

// setter
$( ".selector" ).ojCollapsible( "option", "expandArea", "disclosureIcon" );

expandOn :string

The type of event to expand/collapse the collapsible. To expand the collapsible on hover, use "mouseover".
Default Value:
  • "click"
Deprecated:
  • Yes
Source:
Examples

Initialize the collapsible with the expandOn option specified:

$( ".selector" ).ojCollapsible( { "expandOn": "mouseover" } );

Get or set the expandOn option, after initialization:

// getter
var expandOn = $( ".selector" ).ojCollapsible( "option", "expandOn" );

// setter
$( ".selector" ).ojCollapsible( "option", "expandOn", "mouseover" );

expanded :boolean

Specifies if the content is expanded.
Default Value:
  • false
Source:
Examples

Initialize the collapsible with the expanded option specified:

$( ".selector" ).ojCollapsible( { "expanded": true } );

Get or set the expanded option, after initialization:

// getter
var expanded = $( ".selector" ).ojCollapsible( "option", "expanded" );

// setter
$( ".selector" ).ojCollapsible( "option", "expanded", true );

rootAttributes :Object

Attributes specified here will be set on the component's root DOM element at creation time. This is particularly useful for components like Dialog that wrap themselves in a new root element at creation time.

The supported attributes are id, which overwrites any existing value, and class and style, which are appended to the current class and style, if any.

Setting this option after component creation has no effect. At that time, the root element already exists, and can be accessed directly via the widget method, per the second example below.

Default Value:
  • null
Inherited From:
Source:
Examples

Initialize a JET component, specifying a set of attributes to be set on the component's root DOM element:

// Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc.
$( ".selector" ).ojFoo({ "rootAttributes": {
  "id": "myId",
  "style": "max-width:100%; color:blue;",
  "class": "my-class"
}});

After initialization, rootAttributes should not be used. It is not needed at that time, as attributes of the root DOM element can simply be set directly, using widget:

// Foo is the component, e.g., Menu, Button, InputText, InputNumber, Select, etc.
$( ".selector" ).ojFoo( "widget" ).css( "height", "100px" );
$( ".selector" ).ojFoo( "widget" ).addClass( "my-class" );

translations :Object

A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

If this component has (or inherits) translations, their documentation immediately follows this doc entry.

Default Value:
  • an object containing all resources relevant to the component and all its superclasses, or null if none
Inherited From:
Source:
Examples

Initialize the component, overriding some translated resources. This syntax leaves the other translations intact at create time, but not if called after create time:

// Foo is InputDate, InputNumber, etc.
$( ".selector" ).ojFoo({ "translations": { someKey: "someValue",
                                           someOtherKey: "someOtherValue" } });

Get or set the translations option, after initialization:

// Get one.  (Foo is InputDate, InputNumber, etc.)
var value = $( ".selector" ).ojFoo( "option", "translations.someResourceKey" );

// Get all.  (Foo is InputDate, InputNumber, etc.)
var values = $( ".selector" ).ojFoo( "option", "translations" );

// Set one, leaving the others intact.  (Foo is InputDate, InputNumber, etc.)
$( ".selector" ).ojFoo( "option", "translations.someResourceKey", "someValue" );

// Set many.  Any existing resource keys not listed are lost.  (Foo is InputDate, InputNumber, etc.)
$( ".selector" ).ojFoo( "option", "translations", { someKey: "someValue",
                                                    someOtherKey: "someOtherValue" } );

Sub-ID's

Each subId locator object contains, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component. It can have additional properties to further specify the desired node. See getNodeBySubId and getSubIdByNode methods for more details.

Properties:
Name Type Description
subId string Sub-id string to identify a particular dom node.

Following are the valid subIds:

oj-collapsible-content

Sub-ID for the content of a Collapsible.

Deprecated:
  • This sub-ID is not needed. Since the application supplies this element, it can supply a unique ID by which the element can be accessed.
    Source:
    Example

    Get the Collapsible content:

    var node = $( ".selector" ).ojCollapsible( "getNodeBySubId", {'subId': 'oj-collapsible-content'} );

    oj-collapsible-disclosure

    Sub-ID for the disclosure icon of a Collapsible.

    Source:
    Example

    Get the Collapsible disclosure icon:

    var node = $( ".selector" ).ojCollapsible( "getNodeBySubId", {'subId': 'oj-collapsible-disclosure'} );

    oj-collapsible-header

    Sub-ID for the header of a Collapsible.

    Deprecated:
    • This sub-ID is not needed. Since the application supplies this element, it can supply a unique ID by which the element can be accessed.
      Source:
      Example

      Get the Collapsible header:

      var node = $( ".selector" ).ojCollapsible( "getNodeBySubId", {'subId': 'oj-collapsible-header'} );

      oj-collapsible-header-icon

      Sub-ID for the disclosure icon of a Collapsible.

      Deprecated:
      • this sub-ID is deprecated, please use oj-collapsible-disclosure instead.
        Source:
        Example

        Get the Collapsible disclosure icon:

        var node = $( ".selector" ).ojCollapsible( "getNodeBySubId", {'subId': 'oj-collapsible-header-icon'} );

        Events

        #beforeCollapse

        Triggered immediately before the collapsible is collapsed. beforeCollapse can be canceled to prevent the content from collapsing by returning a false in the event listener.
        Properties:
        Name Type Description
        event Event jQuery event object
        ui Object Parameters
        Properties
        Name Type Description
        header jQuery The header that is about to be collapsed.
        content jQuery The content that is about to be collapsed.
        Source:
        Examples

        Initialize the collapsible with the beforeCollapse callback specified:

        $( ".selector" ).ojCollapsible({
            "beforeCollapse": function( event, ui ) {}
        });

        Bind an event listener to the ojbeforecollapse event:

        $( ".selector" ).on( "ojbeforecollapse", function( event, ui ) {
             // verify that the component firing the event is a component of interest 
             if ($(event.target).is(".mySelector")) {} 
        } );

        #beforeExpand

        Triggered immediately before the collapsible is expanded. beforeExpand can be canceled to prevent the content from expanding by returning a false in the event listener.
        Properties:
        Name Type Description
        event Event jQuery event object
        ui Object Parameters
        Properties
        Name Type Description
        header jQuery The header that is about to be expanded.
        content jQuery The content that is about to be expanded.
        Source:
        Examples

        Initialize the collapsible with the beforeExpand callback specified:

        $( ".selector" ).ojCollapsible({
            "beforeExpand": function( event, ui ) {}
        });

        Bind an event listener to the ojbeforeexpand event:

        $( ".selector" ).on( "ojbeforeexpand", function( event, ui ) {
             // verify that the component firing the event is a component of interest 
             if ($(event.target).is(".mySelector")) {} 
        } );

        collapse

        Triggered after the collapsible has been collapsed.
        Properties:
        Name Type Description
        event Event jQuery event object
        ui Object Parameters
        Properties
        Name Type Description
        header jQuery The header that was just collapsed.
        content jQuery The content that was just collapsed.
        Source:
        Examples

        Initialize the collapsible with the collapse callback specified:

        $( ".selector" ).ojCollapsible({
            "collapse": function( event, ui ) {}
        });

        Bind an event listener to the ojcollapse event:

        $( ".selector" ).on( "ojcollapse", function( event, ui ) {
             // verify that the component firing the event is a component of interest 
             if ($(event.target).is(".mySelector")) {} 
        } );

        destroy

        Triggered before the component is destroyed. This event cannot be canceled; the component will always be destroyed regardless.

        Inherited From:
        Source:
        Examples

        Initialize component with the destroy callback

        // Foo is Button, InputText, etc.
        $(".selector").ojFoo({
          'destroy': function (event, data) {}
        });

        Bind an event listener to the destroy event

        $(".selector").on({
          'ojdestroy': function (event, data) {
              // verify that the component firing the event is a component of interest
              if ($(event.target).is(".mySelector")) {
                  window.console.log("The DOM node id for the destroyed component is : %s", event.target.id);
              }
          };
        });

        expand

        Triggered after the collapsible has been expanded (after animation completes).
        Properties:
        Name Type Description
        event Event jQuery event object
        ui Object Parameters
        Properties
        Name Type Description
        header jQuery The header that was just expanded.
        content jQuery The content that was just expanded.
        Source:
        Examples

        Initialize the collapsible with the expand callback specified:

        $( ".selector" ).ojCollapsible({
            "expand": function( event, ui ) {}
        });

        Bind an event listener to the ojexpand event:

        $( ".selector" ).on( "ojexpand", function( event, ui ) {
             // verify that the component firing the event is a component of interest 
             if ($(event.target).is(".mySelector")) {} 
        } );

        optionChange

        Fired whenever a supported component option changes, whether due to user interaction or programmatic intervention. If the new value is the same as the previous value, no event will be fired. The event listener will receive two parameters described below:
        Properties:
        Name Type Description
        event Event jQuery event object
        ui Object event payload
        Properties
        Name Type Argument Description
        option string the name of the option that changed.
        previousValue Object an Object holding the previous value of the option. When previousValue is not a primitive type, i.e., is an Object, it may hold the same value as the value property.
        value Object an Object holding the current value of the option.
        subproperty Object <nullable>
        an Object holding information about the subproperty that changed.
        Properties
        Name Type Description
        path string the subproperty path that changed.
        previousValue Object an Object holding the previous value of the subproperty.
        value Object an Object holding the current value of the subproperty.
        optionMetadata Object information about the option that changed
        Properties
        Name Type Description
        writeback string "shouldWrite" or "shouldNotWrite". For use by the JET writeback mechanism; 'shouldWrite' indicates that the value should be written to the observable.
        Inherited From:
        Source:
        Examples

        Initialize component with the optionChange callback

        // Foo is Button, InputText, etc.
        $(".selector").ojFoo({
          'optionChange': function (event, ui) {}
        });

        Bind an event listener to the ojoptionchange event

        $(".selector").on({
          'ojoptionchange': function (event, ui) {
              // verify that the component firing the event is a component of interest
              if ($(event.target).is(".mySelector")) {
                  window.console.log("option that changed is: " + ui['option']);
              }
          };
        });

        Methods

        getNodeBySubId(locator) → {Element|null}

        Returns the component DOM node indicated by the locator parameter.

        If the locator or its subId is null, then this method returns the element on which this component was initialized.

        If a non-null subId is provided but no corresponding node can be located, then this method returns null.

        This method is intended for use in test automation only, and should not be used in a production environment.

        Parameters:
        Name Type Description
        locator Object An Object containing, at minimum, a subId property, whose value is a string that identifies a particular DOM node in this component.

        If this component has (or inherits) any subIds, then they are documented in the Sub-ID's section of this document.

        Some components may support additional fields of the locator Object, to further specify the desired node.

        Inherited From:
        Source:
        Returns:
        The DOM node located by the locator, or null if none is found.
        Type
        Element | null
        Example

        Get the node for a certain subId:

        // Foo is ojInputNumber, ojInputDate, etc.
        var node = $( ".selector" ).ojFoo( "getNodeBySubId", {'subId': 'oj-some-sub-id'} );

        getSubIdByNode(node) → {Object|null}

        Returns the subId string for the given DOM node in this component. For details, see getNodeBySubId and the Sub-ID's section of this document.

        This method is intended for use in test automation only, and should not be used in a production environment.

        Parameters:
        Name Type Description
        node Element DOM node in this component
        Inherited From:
        Source:
        Returns:
        The subId for the DOM node, or null if none is found.
        Type
        Object | null
        Example

        Get the subId for a certain DOM node:

        // Foo is ojInputNumber, ojInputDate, etc.
        var locator = $( ".selector" ).ojFoo( "getSubIdByNode", nodeInsideComponent );

        option(optionName, value) → {Object|undefined}

        This method has several overloads, which get and set component options and their fields. The functionality is unchanged from that provided by JQUI. See the examples for details on each overload.

        Parameters:
        Name Type Argument Description
        optionName string | Object <optional>
        the option name (string, first two overloads), or the map (Object, last overload). Omitted in the third overload.
        value Object <optional>
        a value to set for the option. Second overload only.
        Inherited From:
        Source:
        Returns:
        The getter overloads return the retrieved value(s). When called via the public jQuery syntax, the setter overloads return the object on which they were called, to facilitate method chaining.
        Type
        Object | undefined
        Examples

        First overload: get one option:

        This overload accepts a (possibly dot-separated) optionName param as a string, and returns the current value of that option.

        var isDisabled = $( ".selector" ).ojFoo( "option", "disabled" ); // Foo is Button, Menu, etc.
        
        // For object-valued options, dot notation can be used to get the value of a field or nested field.
        var startIcon = $( ".selector" ).ojButton( "option", "icons.start" ); // icons is object with "start" field

        Second overload: set one option:

        This overload accepts two params: a (possibly dot-separated) optionName string, and a new value to which that option will be set.

        $( ".selector" ).ojFoo( "option", "disabled", true ); // Foo is Button, Menu, etc.
        
        // For object-valued options, dot notation can be used to set the value
        // of a field or nested field, without altering the rest of the object.
        $( ".selector" ).ojButton( "option", "icons.start", myStartIcon ); // icons is object with "start" field

        Third overload: get all options:

        This overload accepts no params, and returns a map of key/value pairs representing all the component options and their values.

        var options = $( ".selector" ).ojFoo( "option" ); // Foo is Button, Menu, etc.

        Fourth overload: set one or more options:

        This overload accepts a single map of option-value pairs to set on the component. Unlike the first two overloads, dot notation cannot be used.

        $( ".selector" ).ojFoo( "option", { disabled: true, bar: 42 } ); // Foo is Button, Menu, etc.

        #refresh()

        Refreshes the visual state of the collapsible. JET components require a refresh() or re-init after the DOM is programmatically changed underneath the component.

        This method does not accept any arguments.

        Source:
        Returns:
        When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.
        Example

        Invoke the refresh method:

        $( ".selector" ).ojCollapsible( "refresh" );

        Non-public Methods

        Note: Extending JET components is not currently supported. Thus, non-public methods are for internal use only.

        <protected> _AddActiveable(options)

        Add touch and mouse listeners to toggle oj-active class
        Parameters:
        Name Type Description
        options !Object | !jQuery This parameter can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
        Properties
        Name Type Argument Description
        element jQuery The element(s) to receive the oj-active class on active Required if afterToggle is specified.
        afterToggle function(string) <nullable>
        Optional callback function called each time the active classes have been toggled, after the toggle. The event.type string is passed and indicates whether the classes were added or removed. The active classes are added on "touchstart" or "mousedown" or "mouseenter" and the active classes are removed on "touchend" or "touchcancel" or "mouseup" or "mouseleave". Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-active are applied," can enforce those rules in this callback.
        Inherited From:
        Source:
        See:

        <protected> _AddHoverable(options)

        Add mouse listners to toggle oj-hover class
        Parameters:
        Name Type Description
        options !Object | !jQuery This param can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
        Properties
        Name Type Argument Description
        element jQuery The element(s) to receive the oj-hover class on hover Required if afterToggle is specified.
        afterToggle function(string) <nullable>
        Optional callback function called each time the hover classes have been toggled, after the toggle. The string "mouseenter" or "mouseleave" is passed, indicating whether the classes were added or removed. Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-hover are applied," can enforce those rules in this callback.
        Inherited From:
        Source:
        See:

        <protected> _AfterCreate()

        This method is called after _ComponentCreate, but before the create event is fired. The JET base component does tasks here that must happen after the component (subclass) has created itself in its override of _ComponentCreate. Notably, the base component handles the rootAttributes and contextMenu options here, since those options operate on the component root node, which for some components is created in their override of _ComponentCreate.

        Subclasses should override this method only if they have tasks that must happen after a superclass's implementation of this method, e.g. tasks that must happen after the context menu is set on the component.

        Overrides of this method should call this._super first.

        Inherited From:
        Source:

        <protected> _AfterCreateEvent()

        This method is called after the create event is fired. Components usually should not override this method, as it is rarely correct to wait until after the create event to perform a create-time task.

        An example of a correct usage of this method is Dialog's auto-open behavior, which needs to happen after the create event.

        Only behaviors (like Dialog auto-open behavior) should occur in this method. Component initialization must occur earlier, before the create event is fired, so that create listeners see a fully inited component.

        Overrides of this method should call this._super first.

        Do not confuse this method with the _AfterCreate method, which is more commonly used.

        Inherited From:
        Source:

        <protected> _CompareOptionValues(option, value1, value2) → {boolean}

        Compares 2 option values for equality and returns true if they are equal; false otherwise.

        Parameters:
        Name Type Description
        option String the name of the option
        value1 Object first value
        value2 Object another value
        Inherited From:
        Source:
        Returns:
        Type
        boolean

        <protected> _ComponentCreate()

        All component create-time initialization lives in this method, except the logic that specifically needs to live in _InitOptions, _AfterCreate, or _AfterCreateEvent, per the documentation for those methods. All DOM creation must happen here, since the intent of _AfterCreate, which is called next, is to contain superclass logic that must run after that DOM is created.

        Overrides of this method should call this._super first.

        Summary of create-time methods that components can override, in the order that they are called:

        1. _InitOptions
        2. _ComponentCreate (this method)
        3. _AfterCreate
        4. (The create event is fired here.)
        5. _AfterCreateEvent

        For all of these methods, the contract is that overrides must call this._super first, so e.g., the _ComponentCreate entry means baseComponent._ComponentCreate, then _ComponentCreate in any intermediate subclasses, then _ComponentCreate in the leaf subclass.

        Inherited From:
        Source:

        <protected> _create()

        This method is final in JET. Components should instead override one or more of the overridable create-time methods listed in _ComponentCreate.

        Inherited From:
        Source:

        <protected> _FixRendererContext(context) → {Object}

        Prepares a custom renderer context object for either the JQuery or custom element syntax, removing and exposing keys as needed.
        Parameters:
        Name Type Description
        context Object The renderer context object.
        Inherited From:
        Source:
        Returns:
        The cleaned up renderer context.
        Type
        Object

        <protected> _focusable(options)

        Sets JET's "focus" CSS classes when the element is focused and removes them when focus is lost.

        The oj-focus class is set on all focuses.

        Some components additionally have an oj-focus-highlight class, which applies a focus indicator that is appropriate on a subset of the occasions that oj-focus is appropriate. Those components should pass true for the applyHighlight param, in which case the oj-focus-highlight class is set if appropriate given the current focus highlight policy.

        Focus highlight policy

        The focus highlight policy supports the 3 values listed below. By default, it is retrieved from the $focusHighlightPolicy SASS variable, shared by many components and patterns. Components with different needs, including those exposing a component-specific SASS variable or other API for this, should see the getFocusHighlightPolicy parameter below. Valid focus highlight policies:

        Policy Description
        "nonPointer" Indicates that the component should apply the oj-focus-highlight class only for focuses not resulting from pointer (touch or mouse) interaction. (In the built-in themes, the SASS variable defaults to this value.)
        "all" Indicates that the component should apply the class for all focuses.
        "none" Indicates that the component should never apply the class, because the application has taken responsibility for applying the class when needed for accessibility.
        Toggling the classes

        Components that toggle these focus classes outside of this API must maintain the invariant that oj-focus-highlight is applied to a given element in a (not necessarily strict) subset of cases that oj-focus is applied to that element.

        Typically the specified element should be within the component subtree, in which case the classes will automatically be removed from the element when the component is destroyed, when its disabled option is set to true, and when _NotifyDetached() is called.

        As a minor exception, for components that wrap themselves in a new root node at create time, if the specified element is within the root node's subtree but not within the init node's subtree, then at destroy time only, the classes will not be removed, since destroy() is expected to remove such nodes.

        If the element is NOT in the component subtree, then the caller is responsible for removing the classes at the times listed above.

        Listeners

        If setupHandlers is not passed, or if setupHandlers is passed and uses _on to register its listeners as seen in the example, then the listeners are not invoked when the component is disabled, and the listeners are automatically cleaned up when the component is destroyed. Otherwise, the caller is responsible for ensuring that the disabled state is handled correctly, and removing the listeners at destroy time.

        Related API's

        Non-component internal callers should see oj.DomUtils.makeFocusable(). Per its JSDoc (unpublished; see the source), it has a couple of additional usage considerations.

        Parameters:
        Name Type Description
        options !Object | !jQuery This param can either be the element (convenience syntax for callers needing to specify only the element(s) that would otherwise have been passed as options.element) or an object supporting the following fields:
        Properties
        Name Type Argument Description
        element jQuery The element(s) to receive the oj-focus classes on focus. Required if setupHandlers not passed; ignored otherwise.
        applyHighlight boolean true if the oj-focus-highlight class should be applied when appropriate. false or omitted if that class should never be applied.
        afterToggle function(string) <nullable>
        Optional callback function called each time the focus classes have been toggled, after the toggle. The string "focusin" or "focusout" is passed, indicating whether the classes were added or removed. Components with consistency requirements, such as "oj-default must be applied iff no state classes such as oj-focus are applied," can enforce those rules in this callback.
        getFocusHighlightPolicy function() <nullable>
        Optional if applyHighlight is true; ignored otherwise. Components with a component-specific focus policy mechanism should pass a function that always returns one of the three valid values listed above, keeping in mind that this method can be called on every focus. See the example.
        recentPointer function() <nullable>
        Relevant iff applyHighlight is true and the focus highlight policy is "nonPointer"; ignored otherwise. Recent pointer activity is considered to have occurred if (a) a mouse button or finger has recently been down or up, or (b) this optional callback function returns true. Components wishing to additionally take into account (say) recent pointer movements can supply a function returning true if those movements have been detected, keeping in mind that this method can be called on every focus. See the example.
        setupHandlers function(function(!jQuery),function(!jQuery)) <nullable>
        Can be omitted by components whose focus classes need to be added and removed on focusin and focusout, respectively. Components needing to add/remove those classes in response to other events should specify this parameter, which is called once, immediately. See the examples.
        Inherited From:
        Source:
        Examples

        Opt into the highlight behavior, and specify a function to be called every time the classes are toggled:

        var self = this;
        this._focusable({
            'element': this.element, 
            'applyHighlight': true, 
            'afterToggle' : function() {
                self._toggleDefaultClasses();
            }
        });

        Arrange for mouse movement to be considered in addition to mouse/finger up/down. Also supply a component-specific focusHighlightPolicy:

        var self = this;
        this._focusable({
            'element': someElement, 
            'applyHighlight': true, 
            'recentPointer' : function() {
                // A timestamp-based approach avoids the risk of getting stuck in an inaccessible 
                // state if (say) mouseenter is not followed by mouseleave for some reason.
                var millisSincePointerMove = Date.now() - _myPointerMoveTimestamp;
                var isRecent = millisSincePointerMove < myThreshold;
                return isRecent;
            },
            'getFocusHighlightPolicy' : function() {
                // Return the value of a component-specific SASS $variable, component option, or other 
                // component-specific mechanism, either "all", "none", or "nonPointer".  SASS variables
                // should be pulled into JS once statically on load, not per-instance or per-focus.
            }
        });

        Add/remove the focus classes in response to events other than focusin/focusout:

        var self = this;
        this._focusable({
            'applyHighlight': myBooleanValue, 
            'setupHandlers': function( focusInHandler, focusOutHandler) {
                self._on( self.element, {
                    // This example uses focus/blur listeners, which don't bubble, rather than the 
                    // default focusin/focusout (which bubble).  This is useful when one focusable  
                    // element is a descendant of another.
                    focus: function( event ) {
                        focusInHandler($( event.currentTarget ));
                    },
                    blur: function( event ) {
                        focusOutHandler($( event.currentTarget ));
                    }
                });
            }
        });

        Alternate usage of setupHandlers, which simply stashes the handlers so they can be called from the component's existing handlers:

        var self = this;
        this._focusable({
            'applyHighlight': myBooleanValue, 
            'setupHandlers': function( focusInHandler, focusOutHandler) {
                self._focusInHandler = focusInHandler;
                self._focusOutHandler = focusOutHandler;
            }
        });

        <protected> _getCreateOptions()

        This method is not used in JET. Components should instead override _InitOptions.

        Inherited From:
        Source:

        <protected> _GetEventForSyntax(event) → {Object}

        Given an event, returns the appropriate event for the component syntax. For custom elements, if the event is a JQuery event, this method will return the unwrapped original event.
        Parameters:
        Name Type Description
        event Object [description]
        Inherited From:
        Source:
        Returns:
        Type
        Object

        <protected> _GetReadingDirection() → {string}

        Determines whether the component is LTR or RTL.

        Component responsibilities:

        • All components must determine directionality exclusively by calling this protected superclass method. (So that any future updates to the logic can be made in this one place.)
        • Components that need to know the directionality must call this method at create-time and from refresh(), and cache the value.
        • Components should not call this at other times, and should instead use the cached value. (This avoids constant DOM queries, and avoids any future issues with component reparenting (i.e. popups) if support for directional islands is added.)

        App responsibilities:

        • The app specifies directionality by setting the HTML "dir" attribute on the <html> node. When omitted, the default is "ltr". (Per-component directionality / directional islands are not currently supported due to inadequate CSS support.)
        • As with any DOM change, the app must refresh() the component if the directionality changes dynamically. (This provides a hook for component housekeeping, and allows caching.)
        Default Value:
        • "ltr"
        Inherited From:
        Source:
        Returns:
        the reading direction, either "ltr" or "rtl"
        Type
        string

        <protected> _GetSavedAttributes(element) → {Object|null}

        Gets the saved attributes for the provided element.

        If you don't override _SaveAttributes and _RestoreAttributes, then this will return null.

        If you override _SaveAttributes to call _SaveAllAttributes, then this will return all the attributes. If you override _SaveAttributes/_RestoreAttributes to do your own thing, then you may also have to override _GetSavedAttributes to return whatever you saved if you need access to the saved attributes.

        Parameters:
        Name Type Description
        element Object jQuery selection, should be a single entry
        Inherited From:
        Source:
        Returns:
        savedAttributes - attributes that were saved for this element in _SaveAttributes, or null if none were saved.
        Type
        Object | null

        <protected> _init()

        JET components should almost never implement this JQUI method. Please consult an architect if you believe you have an exception. Reasons:

        • This method is called at create time, after the create event is fired. It is rare for that to be the appropriate time to perform a create-time task. For those rare cases, we have the _AfterCreateEvent method, which is preferred over this method since it is called only at that time, not also at re-init time (see next).
        • This method is also called at "re-init" time, i.e. when the initializer is called after the component has already been created. JET has not yet identified any desired semantics for re-initing a component.
        Inherited From:
        Source:

        <protected> _InitOptions(originalDefaults, constructorOptions)

        This method is called before _ComponentCreate, at which point the component has not yet been rendered. Component options should be initialized in this method, so that their final values are in place when _ComponentCreate is called.

        This includes getting option values from the DOM, where applicable, and coercing option values (however derived) to their appropriate data type if needed.

        No work other than setting options should be done in this method. In particular, nothing should be set on the DOM until _ComponentCreate, e.g. setting the disabled DOM attribute from the disabled option.

        A given option (like disabled) appears in the constructorOptions param iff the app set it in the constructor:

        • If it appears in constructorOptions, it should win over what's in the DOM (e.g. disabled DOM attribute). If for some reason you need to tweak the value that the app set, then enable writeback when doing so: this.option('foo', bar, {'_context': {writeback: true, internalSet: true}}).
        • If it doesn't appear in constructorOptions, then that option definitely is not bound, so writeback is not needed. So if you need to set the option (e.g. from a DOM attribute), use this.option('foo', bar, {'_context': {internalSet: true}}).

        Overrides of this method should call this._super first.

        Parameters:
        Name Type Argument Description
        originalDefaults Object original default options defined on the component and its ancestors
        constructorOptions Object <nullable>
        options passed into the widget constructor
        Inherited From:
        Source:

        <protected> _IsCustomElement() → {boolean}

        Determines whether the component is being rendered as a custom element.
        Inherited From:
        Source:
        Returns:
        True if the component is being rendered as a custom element
        Type
        boolean

        <protected> _IsEffectivelyDisabled() → {boolean}

        Determines whether this component is effectively disabled, i.e. it has its 'disabled' attribute set to true or it has been disabled by its ancestor component.

        Inherited From:
        Source:
        Returns:
        true if the component has been effectively disabled, false otherwise
        Type
        boolean

        <protected> _NotifyAttached()

        Notifies the component that its subtree has been connected to the document programmatically after the component has been created.

        Inherited From:
        Source:

        <protected> _NotifyContextMenuGesture(menu, event, eventType)

        When the contextMenu option is set, this method is called when the user invokes the context menu via the default gestures: right-click, Press & Hold, and Shift-F10. Components should not call this method directly.

        The default implementation simply calls this._OpenContextMenu(event, eventType). Overrides of this method should call that same method, perhaps with additional params, not menu.open().

        This method may be overridden by components needing to do things like the following:

        • Customize the launcher or position passed to _OpenContextMenu(). See that method for guidance on these customizations.
        • Customize the menu contents. E.g. some components need to enable/disable built-in commands like Cut and Paste, based on state at launch time.
        • Bail out in some cases. E.g. components with UX approval to use PressHoldRelease rather than Press & Hold can override this method to say if (eventType !== "touch") this._OpenContextMenu(event, eventType);. When those components detect the alternate context menu gesture (e.g. PressHoldRelease), that separate listener should call this._OpenContextMenu(), not this method (_NotifyContextMenuGesture()), and not menu.open().

        Components needing to do per-launch setup like the above tasks should do so in an override of this method, not in a beforeOpen listener or an _OpenContextMenu() override. This is discussed more fully here.

        Parameters:
        Name Type Description
        menu Object The JET Menu to open as a context menu. Always non-null.
        event Event What triggered the menu launch. Always non-null.
        eventType string "mouse", "touch", or "keyboard". Never null.
        Inherited From:
        Source:

        <protected> _NotifyDetached()

        Notifies the component that its subtree has been removed from the document programmatically after the component has been created.

        Inherited From:
        Source:

        <protected> _NotifyDetached()

        Notifies the component that its subtree has been removed from the document programmatically after the component has been created.

        Inherited From:
        Source:

        <protected> _NotifyHidden()

        Notifies the component that its subtree has been made hidden programmatically after the component has been created.

        Inherited From:
        Source:

        <protected> _NotifyShown()

        Notifies the component that its subtree has been made visible programmatically after the component has been created.

        Inherited From:
        Source:

        <protected> _OpenContextMenu(event, eventType, openOptions, submenuOpenOptions, shallow)

        The only correct way for a component to open its context menu is by calling this method, not by calling Menu.open() or _NotifyContextMenuGesture(). This method should be called in two cases:

        • This method is called by _NotifyContextMenuGesture() and its overrides. That method is called when the baseComponent detects the default context menu gestures: right-click, Press & Hold, and Shift-F10.
        • Components with UX-approved support for alternate context menu gestures like PressHoldRelease should call this method directly when those gestures are detected.

        Components needing to customize how the context menu is launched, or do any per-launch setup, should do so in the caller of this method, (which is one of the two callers listed above), often by customizing the params passed to this method (_OpenContextMenu) per the guidance below. This setup should not be done in the following ways:

        • Components should not perform setup in a beforeOpen listener, as this can cause a race condition where behavior depends on who got their listener registered first: the component or the app. The only correct component use of a beforeOpen listener is when there's a need to detect whether something else launched the menu.
        • Components should not override this method (_OpenContextMenu), as this method is final. Instead, customize the params that are passed to it.

        Guidance on setting OpenOptions fields:

        Launcher:

        Depending on individual component needs, any focusable element within the component can be the appropriate launcher for this launch.

        Browser focus returns to the launcher on menu dismissal, so the launcher must at least be focusable. Typically a tabbable (not just focusable) element is safer, since it just focuses something the user could have focused on their own.

        By default (i.e. if openOptions is not passed, or if it lacks a launcher field), the component init node is used as the launcher for this launch. If that is not focusable or is suboptimal for a given component, that component should pass something else. E.g. components with a "roving tabstop" (like Toolbar) should typically choose the current tabstop as their launcher.

        The :focusable and :tabbable selectors may come in handy for choosing a launcher, e.g. something like this.widget().find(".my-class:tabbable").first().

        Position:

        By default, this method applies positioning that differs from Menu's default in the following ways: (The specific settings are subject to change.)

        • For mouse and touch events, the menu is positioned relative to the event, not the launcher.
        • For touch events, "my" is set to "start>40 center", to avoid having the context menu obscured by the user's finger.

        Usually, if position needs to be customized at all, the only thing that needs changing is its "of" field, and only for keyboard launches (since mouse/touch launches should almost certainly keep the default "event" positioning). This situation arises anytime the element relative to which the menu should be positioned for keyboard launches is different than the launcher element (the element to which focus should be returned upon dismissal). For this case, { "position": {"of": eventType==="keyboard" ? someElement : "event"} } can be passed as the openOptions param.

        Be careful not to clobber useful defaults by specifying too much. E.g. if you only want to customize "of", don't pass other fields like "my", since your value will be used for all modalities (mouse, touch, keyboard), replacing the modality-specific defaults that are usually correct. Likewise, don't forget the eventType==="keyboard" check if you only want to customize "of" for keyboard launches.

        InitialFocus:

        This method forces initialFocus to "menu" for this launch, so the caller needn't specify it.

        Parameters:
        Name Type Argument Description
        event Event What triggered the context menu launch. Must be non-null.
        eventType string "mouse", "touch", or "keyboard". Must be non-null. Passed explicitly since caller knows what it's listening for, and since events like contextmenu and click can be generated by various input modalities, making it potentially error-prone for this method to determine how they were generated.
        openOptions Object <optional>
        Options to merge with this method's defaults, which are discussed above. The result will be passed to Menu.open(). May be null or omitted. See also the shallow param.
        submenuOpenOptions Object <optional>
        Options to be passed through to Menu.open(). May be null or omitted.
        shallow boolean <optional>
        Whether to perform a deep or shallow merge of openOptions with this method's default value. The default and most commonly correct / useful value is false.
        • If true, a shallow merge is performed, meaning that the caller's position object, if passed, will completely replace this method's default position object.
        • If false or omitted, a deep merge is performed. For example, if the caller wishes to tweak position.of while keeping this method's defaults for position.my, position.at, etc., it can pass {"of": anOfValue} as the position value.

        The shallow param is n/a for submenuOpenOptions, since this method doesn't apply any defaults to that. (It's a direct pass-through.)

        Inherited From:
        Source:

        <protected> _ReleaseResources()

        Release resources held by this component, for example, remove listeners. This is called during destroy. _SetupResources will set up resources needed by this component, and is called during _create.

        This base class default implementation does nothing.

        Component subclasses can opt in by overriding _SetupResources and _ReleaseResources.
        Inherited From:
        Source:

        <protected> _RemoveActiveable(element)

        Remove touch and mouse listeners that were registered in _AddActiveable
        Parameters:
        Name Type Description
        element jQuery The same element passed to _AddActiveable
        Inherited From:
        Source:
        See:

        <protected> _RemoveHoverable(element)

        Remove mouse listners that were registered in _AddHoverable
        Parameters:
        Name Type Description
        element jQuery The same element passed to _AddHoverable
        Inherited From:
        Source:
        See:

        <protected> _RestoreAllAttributes()

        Restores all the element's attributes which were saved in _SaveAllAttributes. This method is final in JET.

        If a subclass wants to save/restore all attributes on create/destroy, then the subclass can override _SaveAttributes and call _SaveAllAttributes and also override _RestoreAttributes and call _RestoreAllAttributes.

        Inherited From:
        Source:

        <protected> _RestoreAttributes()

        Restore the attributes saved in _SaveAttributes.

        _SaveAttributes is called during _create. And _RestoreAttributes is called during _destroy.

        This base class default implementation does nothing.

        We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_GetSavedAttributes/_RestoreAttributes.

        Inherited From:
        Source:

        <protected> _SaveAllAttributes(element)

        Saves all the element's attributes within an internal variable. _RestoreAllAttributes will restore the attributes from this internal variable.

        This method is final in JET. Subclasses can override _RestoreAttributes and call _RestoreAllAttributes.

        The JSON variable will be held as:

        [
          {
          "element" : element[i],
          "attributes" :
            {
              attributes[m]["name"] : {"attr": attributes[m]["value"]
            }
          }
        ]
        
        Parameters:
        Name Type Description
        element Object jQuery selection to save attributes for
        Inherited From:
        Source:

        <protected> _SaveAttributes(element)

        Saves the element's attributes. This is called during _create. _RestoreAttributes will restore all these attributes and is called during _destroy.

        This base class default implementation does nothing.

        We also have _SaveAllAttributes and _RestoreAllAttributes methods that save and restore all the attributes on an element. Component subclasses can opt into these _SaveAllAttributes/_RestoreAllAttributes implementations by overriding _SaveAttributes and _RestoreAttributes to call _SaveAllAttributes/_RestoreAllAttributes. If the subclass wants a different implementation (like save only the 'class' attribute), it can provide the implementation itself in _SaveAttributes/_RestoreAttributes.

        Parameters:
        Name Type Description
        element Object jQuery selection to save attributes for
        Inherited From:
        Source:

        <protected> _SetRootAttributes()

        Reads the rootAttributes option, and sets the root attributes on the component's root DOM element. See rootAttributes for the set of supported attributes and how they are handled.

        Inherited From:
        Source:
        Throws:
        if unsupported attributes are supplied.

        <protected> _SetupResources()

        Sets up needed resources for this component, for example, add listeners. This is called during _create. _ReleaseResources will release resources help by this component, and is called during destroy.

        This base class default implementation does nothing.

        Component subclasses can opt in by overriding _SetupResources and _ReleaseResources.
        Inherited From:
        Source:

        <protected> _UnregisterChildNode()

        Remove all listener references that were attached to the element.
        Inherited From:
        Source: