Component: ojPopup

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

Options

oj. ojPopup extends oj.baseComponent

Version:
  • 3.2.0

JET Popup Component

Description: Themeable, WAI-ARIA-compliant popup that can display arbitrary content.

A JET popup can be created from a block ( <div> ), inline element ( <span> ) or custom element ( <oj-popup> ). This element will become the root - outer chrome of the popup. The content of the popup will be relocated under an element marked with the .oj-popup-content selector. Dynamic content can be inserted under the element identified by the .oj-popup-content selector. However, page developers are encouraged to create their own content element to anchor dynamic content changes versus using .oj-popup-content as the marker selector.

<oj-popup id="popup">
  <span class="mycontent">
    Hello World!
  </span class="mycontent">
</oj-popup>

The following is an example of dynamically changing the content of the popup defined above.

var content = $( "#popup" ).find( ".mycontent" ).first();
content.text("Hello Universe!");

For WAI-ARIA compliance, JET automatically adds role="tooltip" to the root popup dom element by default. The role option controls the WAI-ARIA role. The popup also adds the aria-describedby="popup-id" to the launcher while the popup is open.

Touch End User Information

Target Gesture Action
Outside popup or launcher Tap Close the popup.

Disabled items do not allow any touch interaction.

Keyboard End User Information

Target Key Action
Focus within Popup Tab or Shift + Tab Navigate the content of the popup. Close the open popup if there are no tab stops in the popup.
F6 Move focus to the launcher for a popup with modeless modality. Close the open popup if the modality is modal.
Esc Close the open popup.
Popup Launcher F6 Move focus to the first tab stop within the open popup. If there is not a tab stop within the content, focus is established on the popup.


Accessibility

One point often overlooked is making the gestures that launch a popup accessible. There are no constraints to what events a page developer might choose to trigger opening a popup. The choice should be accessible for screen reader users. Page developers should take care when using mouse events to trigger opening of a popup. This is especially important if the content of the popup can't be derived from other visible areas on the page. In cases that mouseover, mouseout, mouseenter, mouseleave and hover events are used to launch popups, there needs to be a keyboard functional equivalency.

See also the oj-focus-highlight discussion.

Pseudo-selectors

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

var popups = $( ":oj-popup" )

Reparenting

When popups are open, they will be reparented in the document and reparented back when closed. When open, the location of the popup within the document will be in context of how it's used. Popups open from other popups will be relocated in the document into the nearest parent popup's layer. The popups layer defines its z-index weight "stacking context". The ojPopup's layer is marked with the "oj-popup-layer" style. The context of opening is defined by the launcher argument passed to the open method. If not open from another popup, the popup will be reparented to a container in the document body. Popups of the same type are assigned the same z-index values. The layering between peer popups reflect the opening order. The popup that has active focus will be assigned a greater z-index value. This is applied to the popup's layer by way of the "oj-focus-within" pseudo selector applied with "oj-popup-layer" selector. The page author has control over z-index weights by way of the "oj-popup-layer" selector.

There are known caveats with this design. However, these scenarios are considered "bad use" based on our JET popup strategy.

  1. Events raised within the popup will not bubble up to the popup's original ancestors. Instead, listeners for popup events should be applied to either the popup's root element, or the document.
  2. Likewise, developers should not use CSS descendant selectors, or similar logic, that assumes that the popup will remain a child of its original parent.
  3. Popups containing iframes are problematic. The iframe elements "may" fire a HTTP GET request for its src attribute each time the iframe is reparented in the document.
  4. In some browsers, reparenting a popup that contains elements having overflow, will cause these overflow elements to reset their scrollTop.

Styling

The following CSS classes can be applied by the page author as needed.

Class Description Example
oj-focus-highlight Under normal circumstances this class is applied automatically. It is documented here for the rare cases that an app developer needs per-instance control.

The oj-focus-highlight class applies focus styling that may not be desirable when the focus results from pointer interaction (touch or mouse), but which is needed for accessibility when the focus occurs by a non-pointer mechanism, for example keyboard or initial page load.

The application-level behavior for this component is controlled in the theme by the $focusHighlightPolicy SASS variable; however, note that this same variable controls the focus highlight policy of many components and patterns. The values for the variable are:

  • nonPointer: oj-focus-highlight is applied only when focus is not the result of pointer interaction. Most themes default to this value.
  • all: oj-focus-highlight is applied regardless of the focus mechanism.
  • none: oj-focus-highlight is never applied. This behavior is not accessible, and is intended for use when the application wishes to use its own event listener to precisely control when the class is applied (see below). The application must ensure the accessibility of the result.

To change the behavior on a per-instance basis, the application can set the SASS variable as desired and then use event listeners to toggle this class as needed.

<oj-popup class="oj-focus-highlight">
 <input id="blueopt" type="checkbox" value="blue">
 <label for="blueopt">Blue</label>
</oj-popup>

Event Handling

  • beforeClose(event, ui) - Triggered before a popup closes. Event can prevent closing the popup; However, there are cases the framework must veto, such as when the popup is destroyed.
  • beforeOpen(event, ui) - Triggered before a popup closes. Event can prevent opening the popup.
  • close(event, ui) - Triggered after the popup has closed.
  • create(event, ui) - Triggered after the component has been bound to an associated dom element.
  • focus(event, ui) - Triggered when initial focus is established on opening, depending on the value of the initalFocus option, or F6 focus toggle from the associated launcher.
  • open(event, ui) - Triggered after the popup has been made visible.

Initializer

.ojPopup(options)

Creates a JET Popup.
Parameters:
Name Type Argument Description
options Object <optional>
a map of option-value pairs to set on the component
Source:
Examples

Initialize the popup with no options specified:

$( ".selector" ).ojPopup();

Initialize the popup with behaviors of a notewindow:

$( ".selector" ).ojPopup({initialFocus: 'none', autoDismiss: 'focusLoss', tail: 'simple'});

Initialize a popup via the JET ojComponent binding:

<div id="popup1" data-bind="ojComponent: {component: 'ojPopup'}">This is a popup!</div>

Options

autoDismiss :string

Defines conditions that will cause an open popup to auto close dismiss. A value of focusLoss defines the dismissal condition where focus has left the content of the popup or from the associated launcher or if what the popup is aligned to is not fully visible within an overflow area.
Supported Values:
Name Type Description
"none" string disables auto dismissal behaviors.
"focusLoss" string defines auto dismissal behavior when focus leaves the content of the popup or associated launcher. In addition, if what the popup is positioned to is clipped within an overflow area, the popup will auto close dismiss.
Default Value:
  • "focusLoss"
Source:
Examples

Initialize the popup with autoDismiss option specified:

$( ".selector" ).ojPopup( { "autoDismiss": "focusLoss" } );

Get or set the autoDismiss option, after initialization:

// getter
var autoDismiss = $( ".selector" ).ojPopup( "option", "autoDismiss" );
// setter
$( ".selector" ).ojPopup( "option", "autoDismiss", "none" );

chrome :string

Defines the presents of border, shadow and background color of the root popup dom. Value of none applies the oj-popup-no-chrome selector defined by the active theme to the root dom of the popup to remove the default chrome.
Supported Values:
Name Type Description
"default" string describes the popups border, shadow, and background color defined by the active theme.
"none" string turns off the outer chrome defined by the active theme.
Default Value:
  • "default"
Source:
Examples

Initialize the popup with chrome option specified:

$( ".selector" ).ojPopup( { "chrome": "none" } );

Get or set the chrome option, after initialization:

// getter
var chrome = $( ".selector" ).ojPopup( "option", "chrome" );

// setter
$( ".selector" ).ojPopup( "option", "chrome", "none" );

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

initialFocus :string

Determines if the popup should steal focus to its content when initially open. A value of none prevents the popup from grabbing focus when open.
Supported Values:
Name Type Description
"auto" string option is derived from the values of the modality and autoDismiss options
"none" string prevents the popup from stealing focus when open.
"firstFocusable" string defines that a popup should grab focus to the first focusable element within the popup's content.
"popup" string focus to the root popup container (good choice for touch platforms).
Default Value:
  • "auto"
Source:
Examples

Initialize the popup with initialFocus option specified:

$( ".selector" ).ojPopup( { "initialFocus": "none" } );

Get or set the initialFocus option, after initialization:

// getter
var initialFocus = $( ".selector" ).ojPopup( "option", "initialFocus" );

// setter
$( ".selector" ).ojPopup( "option", "initialFocus", "none" );

modality :string

Determines if the popup should block user input of the page behind with a blocking overlay pane.

The default modality varies by theme. Each theme can set its default by setting $popupModalityOptionDefault as seen in the example below.

Supported Values:
Name Type Description
"modeless" string defines a modeless popup.
"modal" string The popup is modal. Interactions with other page elements are disabled. Modal popups overlay other page elements.
Default Value:
  • Varies by theme. "modless" if not specified in theme
Source:
Examples

Initialize the popup to have modality modality

$(".selector" ).ojPopup( {modality: "modal" } );

Get or set the modality option, after initialization:

// getter
var modality = $(".selector" ).ojPopup( "option", "modality" );

// setter
$(".selector" ).ojPopup( "option", "modality", "modal");

Set the default in the theme (SCSS) :

$popupModalityOptionDefault: modal !default;

position :Object

Position object is used to establish the location the popup will appear relative to another element. Positioning defines "my" alignment "at" the alignment "of" some other thing which can be "offset" by so many pixels.

The "my" and "at" properties defines aligment points relative to the popup and other element. The "my" property represents the popups alignment where the "at" property represents the other element that can be identified by "of" or defauts to the launcher when the popup opens. The values of these properties describe horizontal and vertical alignments.

Deprecated:
  • jQuery UI position syntax is deprectated in v3.0.0; Use of a percent unit with "my" or "at" is not supported.
    Source:
    Examples

    Initialize the popup with position option specified:

    $( ".selector" ).ojPopup( { "position": {"my": {"horizontal":"left", "vertical": "top"},
                                       "at": {"horizontal":"right", "vertical": "top"} } );

    Get or set the position option, after initialization:

    // getter
    var position = $( ".selector" ).ojPopup( "option", "position" );
    
    // setter
    $( ".selector" ).ojPopup( "option", "position",
       {"my": {"horizontal": "start", "vertical": "bottom"},
        "at": {"horizontal": "end", "vertical": "top" },
        "offset": {"x": 0, "y":5}} );

    position.at :{horizontal:string, vertical:string}

    Defines which position on the target element ("of") to align the positioned element against.
    Default Value:
    • {"horizontal":"start","vertical":"bottom"}
    Source:

    position.at.horizontal :string

    Supported Values:
    Name Type Description
    "start" string evaluates to "left" in LTR mode and "right" in RTL mode.
    "end" string evaluates to "right" in LTR mode and "left" in RTL mode.
    "left" string
    "center" string
    "right" string
    Default Value:
    • start
    Source:

    position.at.vertical :string

    Supported Values:
    Name Type
    "top" string
    "center" string
    "bottom" string
    Default Value:
    • top
    Source:

    position.collision :string

    Defines rules for alternate alignment.
    Supported Values:
    Name Type Description
    "flip" string the element to the opposite side of the target and the collision detection is run again to see if it will fit. Whichever side allows more of the element to be visible will be used.
    "fit" string shift the element away from the edge of the window.
    "flipfit" string first applies the flip logic, placing the element on whichever side allows more of the element to be visible. Then the fit logic is applied to ensure as much of the element is visible as possible.
    "none" string no collision detection.
    Default Value:
    • flip
    Source:

    position.my :{horizontal:string, vertical:string}

    Defines which edge on the popup to align with the target ("of") element.
    Default Value:
    • {"horizontal":"start","vertical":"top"}
    Source:

    position.my.horizontal :string

    Supported Values:
    Name Type Description
    "start" string evaluates to "left" in LTR mode and "right" in RTL mode.
    "end" string evaluates to "right" in LTR mode and "left" in RTL mode.
    "left" string
    "center" string
    "right" string
    Default Value:
    • start
    Source:

    position.my.vertical :string

    Supported Values:
    Name Type
    "top" string
    "center" string
    "bottom" string
    Default Value:
    • top
    Source:

    position.of :string|{x, number, y: number}|undefined

    Which element to position the popup against. The default is the launcher argument passed to the open method. If the value is a string, it should be a selector or the literal string value of window. Otherwise, a point of x,y. When a point is used, the values are relative to the whole document. Page horizontal and vertical scroll offsets need to be factored into this point - see UIEvent pageX, pageY.
    Source:
    Example

    Finding the point for an svg element:

    var rect = svgDom.getBoundingClientRect();
    var position = {of:{x:rect.left + window.pageXOffset, y:rect.top + window.pageYOffset}};

    position.offset :{x:number, y:number}

    Defines a point offset in pixels from the ("my") alignment.
    Source:

    position.offset.x :number

    Default Value:
    • 0
    Source:

    position.offset.y :number

    Default Value:
    • 0
    Source:

    role :string

    The WAI-ARIA role of the popup. By default, role="tooltip" is added to the generated HTML markup that surrounds the popup.
    Supported Values:
    Name Type Description
    "tooltip" string defines contextual popup that displays a description for an element.
    "dialog" string defines an application window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response.
    "alertdialog" string defines type of dialog that contains an alert message, where initial focus goes to an element within the dialog.
    Default Value:
    • "tooltop"
    Source:
    Examples

    Initialize the popup with the role option specified:

    $(".selector" ).ojPopup( {role: "alertdialog" } );

    Get or set the role option, after initialization:

    // getter
    var role = $(".selector" ).ojPopup( "option", "role" );
    
    // setter
    $(".selector" ).ojDialog( "option", "role", "alertdialog");

    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" );

    tail :string

    Determines if a decoration will be displayed from the popup that points to the element the popup is aligned to. The simple value enables the tail defined by the current theme. In addtion, the oj-popup-tail-simple selector will be applied to the root dom element. This is to allow the box-shadow, z-index and other chrome styling to vary per tail decoration.
    Supported Values:
    Name Type Description
    "none" string no decoration will be displayed from the popup pointing to the launcher.
    "simple" string enables showing the tail defined by the current theme.
    Default Value:
    • "none"
    Source:
    Examples

    Initialize the popup with tail option specified:

    $( ".selector" ).ojPopup( { "tail": "simple" } );

    Get or set the tail option, after initialization:

    // getter
    var tail = $( ".selector" ).ojPopup( "option", "tail" );
    
    // setter
    $( ".selector" ).ojPopup( "option", "tail", "simple" );

    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" } );

    Events

    #animateEnd

    Triggered when a default animation has ended, such as when the component is being opened/closed or a child item is being added/removed. This event is not triggered if the application has called preventDefault on the animateStart event.
    Properties:
    Name Type Description
    event Event jQuery event object
    ui.element Object target of animation
    ui.action string The action that is starting the animation. The number of actions can vary from component to component. Suggested values are:
    • "open" - when a popup component is opened
    • "close" - when a popup component is closed
    Source:
    Examples

    Bind an event listener to the animateend event to listen for "open" ending animation:

    $( ".selector" ).ojPopup({"animateEnd": function( event, ui )
      {
        // verify that the component firing the event is a component of interest and action
        is open
        if (ui.action === "open") {}
      }
    } );

    Bind an event listener to the ojanimateend event to listen for the "close" ending animation:

    $( ".selector" ).on( "ojanimateend", function( event, ui )
      {
        // verify that the component firing the event is a component of interest and action
         is close
        if ($(event.target).is(".mySelector") && ui.action == "close") {}
      } );

    The default open and close animations are controlled via the theme (SCSS) :

    $popupOpenAnimation: (effect: "zoomIn", fade: true)  !default;
    $popupCloseAnimation: (effect: "zoomOut", fade: true)  !default;

    #animateStart

    Triggered when a default animation is about to start, such as when the component is being opened/closed or a child item is being added/removed. The default animation can be cancelled by calling event.preventDefault.
    Properties:
    Name Type Description
    event Event jQuery event object
    ui Object Parameters
    Properties
    Name Type Description
    action string The action that is starting the animation. The number of actions can vary from component to component. Suggested values are:
    • "open" - when a popup component is opened
    • "close" - when a popup component is closed
    element Element target of animation
    endCallback function If the event listener calls event.preventDefault to cancel the default animation, It must call the endCallback function when it finishes its own animation handling and any custom animation has ended.
    Source:
    Examples

    Bind an event listener to the animatestart event to override the default "open" animation:

    $( ".selector" ).ojPopup({"animateStart": function( event, ui )
      {
        // verify that the component firing the event is a component of interest and action
         is open
        if ($(event.target).is(".mySelector") && ui.action === "open") {
          event.preventDefault();
          oj.AnimationUtils.slideIn(ui.element).then(ui.endCallback);
      }
    } );

    Bind an event listener to the ojanimatestart event to override the default "close" animation:

    $( ".selector" ).on( "ojanimatestart", function( event, ui )
      {
        // verify that the component firing the event is a component of interest and action
         is close
        if ($(event.target).is(".mySelector") && ui.action == "close") {
          event.preventDefault();
          oj.AnimationUtils.slideOut(ui.element).then(ui.endCallback);
      } );

    The default open and close animations are controlled via the theme (SCSS) :

    $popupOpenAnimation: ((effect: "zoomIn"), "fadeIn")  !default;
    $popupCloseAnimation: ((effect: "zoomOut", persist: "all"), "fadeOut")  !default;

    #beforeClose

    Triggered before the popup is dismissed via the close() method. The close can be cancelled by calling event.preventDefault().
    Properties:
    Name Type Description
    event Event jQuery event object
    ui Object currently empty
    Source:
    Examples

    Initialize the popup with the beforeClose callback specified:

    $( ".selector" ).ojPopup({
        "beforeClose": function( event, ui ) {}
    });

    Bind an event listener to the ojbeforeclose event:

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

    #beforeOpen

    Triggered before the popup is launched via the open() method. The launch can be cancelled by calling event.preventDefault().
    Properties:
    Name Type Description
    event Event jQuery event object
    ui Object currently empty
    Source:
    Examples

    Initialize the popup with the beforeOpen callback specified:

    $( ".selector" ).ojPopup({
        "beforeOpen": function( event, ui ) {}
    });

    Bind an event listener to the ojbeforeopen event:

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

    #close

    Triggered after the popup is dismissed via the close() method.
    Properties:
    Name Type Description
    event Event jQuery event object
    ui Object currently empty
    Source:
    Examples

    Initialize the popup with the close callback specified:

    $( ".selector" ).ojPopup({
        "close": function( event, ui ) {}
    });

    Bind an event listener to the ojclose event:

    $( ".selector" ).on( "ojclose", 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);
          }
      };
    });

    #focus

    Triggered after focus has been transfered to the popup. This will occur after the open() method is called, depending on the value of the initialFocus option. It's also triggered when using the F6 key to toggle focus from the associated launcher element to the content of the popup.
    Properties:
    Name Type Description
    event Event jQuery event object
    ui Object currently empty
    Source:
    Examples

    Initialize the popup with the focus callback specified:

    $( ".selector" ).ojPopup({
        "focus": function( event, ui ) {}
    });

    Bind an event listener to the ojfocus event:

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

    #open

    Triggered after the popup is launched via the open() method.
    Properties:
    Name Type Description
    event Event jQuery event object
    ui Object currently empty
    Source:
    Examples

    Initialize the popup with the open callback specified:

    $( ".selector" ).ojPopup({
        "open": function( event, ui ) {}
    });

    Bind an event listener to the ojopen event:

    $( ".selector" ).on( "ojopen", 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

    close()

    Closes the popup. This method does not accept any arguments.
    Source:
    Fires:
    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 close method:

    var close = $( ".selector" ).ojPopup( "close" );

    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 );

    isOpen() → {boolean}

    Returns the state of whether the popup is currently open. This method does not accept any arguments.
    Source:
    Returns:
    true if the popup is open.
    Type
    boolean
    Example

    Invoke the isOpen method:

    var isOpen = $( ".selector" ).ojPopup( "isOpen" );

    open(launcher, position)

    Opens the popup. This method accepts two arguments but both are optional.
    Parameters:
    Name Type Argument Description
    launcher string | jQuery | Element <nullable>
    jquery object, jquery selector or dom element that is associated with the popup.
    position Object <nullable>
    an element relative to another
    Source:
    Fires:
    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 open method:

    var open = $( ".selector" ).ojPopup( "open" );

    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()

    Causes the popup to reevaluate its position. Call this function after the content of the popup has dynamically changed while the popup is open.

    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" ).ojPopup( "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()

    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()

    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> _destroy()

    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> _setOption(key, value)

    Parameters:
    Name Type Argument Description
    key string option name
    value Object <nullable>
    of the target option identified by the key
    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: