Class: ojRatingGauge

Oracle® JavaScript Extension Toolkit (JET)
1.1.2

E65298-01

QuickNav

Options


Sub-ID's

oj. ojRatingGauge extends oj.dvtBaseGauge

Version:
  • 1.1.2
Since:
  • 0.7

JET Rating Gauge Component

Rating gauge component for JET. Rating gauges are typically used to display or accept user feedback on a product or service.

This component should be bound to an HTML div element, and the SVG DOM that it generates should be treated as a black box, as it is subject to change. This component should not be extended.


<div data-bind="ojComponent: {component: 'ojRatingGauge', value: 4}"/>

Accessibility

The application is responsible for populating the shortDesc value in the component options object with meaningful descriptors when the component does not provide a default descriptor. Since component terminology for keyboard and touch shortcuts can conflict with those of the application, it is the application's responsibility to provide these shortcuts, possibly via a help popup.

Touch End User Information

Gesture Action
Press & Hold Display tooltip.
Drag Value change when readOnly is false.

Keyboard End User Information

Key Action
Tab Move focus to next component.
Shift + Tab Move focus to previous component.
UpArrow Increase value.
DownArrow Decrease value.
LeftArrow Decrease value in left-to-right locales. Increase value in right-to-left locales.
RightArrow Increase value in left-to-right locales. Decrease value in right-to-left locales.

Reading direction

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

Initializer

.ojRatingGauge()

Creates a JET Rating Gauge.
Source:
Examples

Initialize the Rating Gauge with no options specified:

$(".selector").ojRatingGauge();

Initialize the Rating Gauge with some options:

$(".selector").ojRatingGauge({value: 4});

Initialize the Rating Gauge via the JET ojComponent binding:

<div data-bind="ojComponent: {component: 'ojRatingGauge'}">

Options

changed :boolean

Whether there has been a value entered by the user.
Default Value:
  • false
Source:

changedState :object

The changed shape for the gauge. Displayed after the user has set a value, or when the changed attribute of the data object is set to true.
Default Value:
  • null
Source:

changedState.borderColor :string

The border color for changed state.
Default Value:
  • null
Source:

changedState.color :string

The color for changed state.
Default Value:
  • null
Source:

changedState.shape :string

For choosing a built-in shape.
Supported Values:
Name Type
"circle" string
"rectangle" string
"diamond" string
"triangle" string
"human" string
"star" string
Default Value:
  • "star"
Source:

contextMenu :Object

JQ selector identifying 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.

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.

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

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., Menu, Button, 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

hoverState :object

The shape that displays on hover.
Default Value:
  • null
Source:

hoverState.borderColor :string

The border color for hover state.
Default Value:
  • null
Source:

hoverState.color :string

The color for hover state.
Default Value:
  • null
Source:

hoverState.shape :string

For choosing a built-in shape.
Supported Values:
Name Type
"circle" string
"rectangle" string
"diamond" string
"triangle" string
"human" string
"star" string
Default Value:
  • "star"
Source:

max :number

Integer value specifying the maximum value of the gauge, which determines the number of shapes or images that are displayed.
Default Value:
  • 5
Source:

min :number

The minimum value that can be set on the gauge by the end user. Does not affect the value set on the gauge by API.
Default Value:
  • 0
Source:

orientation :string

Defines the type of rating gauge to be rendered.
Supported Values:
Name Type
"vertical" string
"horizontal" string
Default Value:
  • "horizontal"
Source:

readOnly :boolean

Defines whether the value of the gauge can be changed by the end user.
Default Value:
  • true
Source:

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

selectedState :object

The selected shape for the gauge.
Default Value:
  • null
Source:

selectedState.borderColor :string

The border color for selected state.
Default Value:
  • null
Source:

selectedState.color :string

The color for selected state.
Default Value:
  • null
Source:

selectedState.shape :string

For choosing a built-in shape.
Supported Values:
Name Type
"circle" string
"rectangle" string
"diamond" string
"triangle" string
"human" string
"star" string
Default Value:
  • "star"
Source:

step :number

Specifies the increment by which values can be specified by the end user.
Supported Values:
Name Type
0.5 number
1 number
Default Value:
  • 1
Source:

thresholds :Array.<Object>

An array of objects with the following properties defining the thresholds for the gauge.
Default Value:
  • null
Source:

thresholds[].borderColor :string

The border color of the threshold.
Default Value:
  • null
Source:

thresholds[].color :string

The color of the threshold.
Default Value:
  • null
Source:

thresholds[].max :number

The upper bound of the threshold. This value is ignored for the final threshold, which uses the maximum value of the gauge.
Default Value:
  • null
Source:

thresholds[].shortDesc :string

Specific description for the threshold and overwrites the shortDesc specified on gauge. This is used for accessibility and also for customizing the tooltip text.
Default Value:
  • null
Source:

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

translations.componentName :string

Used to describe the data visualization type for accessibility.

See the translations option for usage examples.

Default Value:
  • "Gauge"
Inherited From:
Source:

translations.labelAndValue :string

Used to display a label and its value.

See the translations option for usage examples.

Default Value:
  • "{0}: {1}"
Inherited From:
Source:

translations.labelClearSelection :string

Text shown for clearing multiple selection on touch devices.

See the translations option for usage examples.

Default Value:
  • "Clear Selection"
Inherited From:
Source:

translations.labelDataVisualization :string

Label for data visualizations used for accessibility.

See the translations option for usage examples.

Default Value:
  • "Data Visualization"
Inherited From:
Source:

translations.labelInvalidData :string

Text shown when the component receives invalid data.

See the translations option for usage examples.

Default Value:
  • "Invalid data"
Inherited From:
Source:

translations.labelNoData :string

Text shown when the component receives no data.

See the translations option for usage examples.

Default Value:
  • "No data to display"
Inherited From:
Source:

translations.messageNotReadyToRender :object

Provides properties to customize the summary text used for the not ready to render error message.

See the translations option for usage examples.

Inherited From:
Source:

translations.messageNotReadyToRender.summary :string

Summary text for the not ready to render error message.

See the translations option for usage examples.

Default Value:
  • "This component must be attached to a visible subtree of the DOM prior to rendering."
Inherited From:
Source:

translations.stateCollapsed :string

Used to describe the collapsed state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Collapsed"
Inherited From:
Source:

translations.stateDrillable :string

Used to describe a drillable object for accessibility.

See the translations option for usage examples.

Default Value:
  • "Drillable"
Inherited From:
Source:

translations.stateExpanded :string

Used to describe the expanded state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Expanded"
Inherited From:
Source:

translations.stateHidden :string

Used to describe the hidden state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Hidden"
Inherited From:
Source:

translations.stateIsolated :string

Used to describe the isolated state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Isolated"
Inherited From:
Source:

translations.stateMaximized :string

Used to describe the maximized state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Maximized"
Inherited From:
Source:

translations.stateMinimized :string

Used to describe the minimized state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Minimized"
Inherited From:
Source:

translations.stateSelected :string

Used to describe the selected state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Selected"
Inherited From:
Source:

translations.stateUnselected :string

Used to describe the unselected state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Unselected"
Inherited From:
Source:

translations.stateVisible :string

Used to describe the visible state for accessibility.

See the translations option for usage examples.

Default Value:
  • "Visible"
Inherited From:
Source:

unselectedState :object

The unselected shape for the gauge.
Default Value:
  • null
Source:

unselectedState.borderColor :string

The border color for unselected state.
Default Value:
  • null
Source:

unselectedState.color :string

The color for unselected state.
Default Value:
  • null
Source:

unselectedState.shape :string

For choosing a built-in shape
Supported Values:
Name Type
"circle" string
"rectangle" string
"diamond" string
"triangle" string
"human" string
"dot" string
"none" string
"star" string
Default Value:
  • "star"
Source:

value :number

The value set on the gauge.
Default Value:
  • null
Source:

visualEffects :string

Defines whether visual effects such as overlays are applied to the gauge.
Supported Values:
Name Type
"none" string
"auto" string
Default Value:
  • "auto"
Source:

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-ratinggauge-tooltip

Sub-ID for the the rating guage tooltip.

See the getNodeBySubId and getSubIdByNode methods for details.

Source:
Example

Get the tooltip object of the gauge, if displayed:

var nodes = $( ".selector" ).ojRatingGauge( "getNodeBySubId", {'subId': 'oj-ratinggauge-tooltip'} );

Events

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) {
      window.console.log("The DOM node id for the destroyed component is : %s", event.target.id);
  };
});

input

Triggered during a value change gesture on mouse or touch move.
Properties:
Name Type Description
ui Object event payload
Properties
Name Type Description
value number the value of the gauge
Source:
Examples

Initialize the component with the input callback specified:

$(".selector").ojRatingGauge({
  "input": function(event, ui){}
});

Bind an event listener to the ojinput event:

$(".selector").on("ojinput", function(event, ui){});

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.
Properties:
Name Type Description
data Object event payload
Properties
Name Type Description
option string the name of the option that changed, i.e. "value"
previousValue Object an Object holding the previous value of the option
value Object an Object holding the current value of the option
ui.optionMetadata Object information about the option that is changing
Properties
Name Type Description
writeback string "shouldWrite" or "shouldNotWrite". For use by the JET writeback mechanism.
Source:
Examples

Initialize the component with the optionChange callback:

$(".selector").ojRatingGauge({
  'optionChange': function (event, data) {} 
});

Bind an event listener to the ojoptionchange event:

$(".selector").on({
  'ojoptionchange': function (event, data) {
      window.console.log("option changing is: " + data['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 subId was provided but no corresponding node can be located, then this method returns null. For more details on subIds, see the subIds section.

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.

Subclasses of this component may support additional fields of the locator Object, to further specify the desired node.

Inherited From:
Source:
Returns:
The DOM node located by the subId string passed in 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'} );

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

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

refresh()

Refreshes the component.

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

Non-public Methods

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

<protected> _AddAutomationGetters(map)

Adds getters for the properties on the specified map.
Parameters:
Name Type Description
map Object | null
Inherited From:
Source:

<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> _ConvertLocatorToSubId(locator) → {string|null}

Converts the specified locator object into a subId string.
Parameters:
Name Type Description
locator Object
Inherited From:
Source:
Returns:
Type
string | null

<protected> _ConvertSubIdToLocator(subId) → {Object|null}

Converts the specified subId string into a locator object.
Parameters:
Name Type Description
subId string
Inherited From:
Source:
Returns:
Type
Object | null

<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> _CreateDvtComponent(context, callback, callbackObj)

Called by _create to instantiate the specific DVT component instance. Subclasses must override.
Parameters:
Name Type Description
context dvt.DvtContext
callback Function
callbackObj Object
Inherited From:
Source:

<protected> _GetChildStyleClasses() → {Object}

Returns a map of the style classes associated with a component's children.
Inherited From:
Source:
Returns:
Type
Object

<protected> _GetComponentStyleClasses() → {Array}

Returns the style classes associated with the component.
Inherited From:
Source:
Returns:
Type
Array

<protected> _getCreateOptions()

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

Inherited From:
Source:

<protected> _GetDvtComponent(element) → {Object}

Returns a DVT component associated with a DOMElement
Parameters:
Name Type Description
element Element The DOMElement to get the DVT component from.
Inherited From:
Source:
Returns:
The DVT component associated with the DOMElement or null
Type
Object

<protected> _GetEventTypes() → {Array}

Returns an array of supported event types. Used in conjunction with _setOptions to skip unnecessary rendering when event listeners are bound. Subclasses must override to return supported event types.
Inherited From:
Source:
Returns:
Type
Array

<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> _GetTranslatedResource(key, params)

Retrieves the translated resource with the specified
Parameters:
Name Type Description
key string The key used to retrieve the translated resource.
params Array.<string> The array of named parameters that need to be converted into index based parameters.
Inherited From:
Source:

<protected> _GetTranslationMap() → {Object}

Returns a map containing keys corresponding to the string ids in ojtranslations.js and values corresponding to the toolkit constants for the DvtBundle objects. This map must be guaranteed to be a new instance so that subclasses can add their translations to it.
Inherited From:
Source:
Returns:
Type
Object

<protected> _HandleEvent(event)

Called by the component to process events. Subclasses should override to delegate DVT component events to their JQuery listeners.
Parameters:
Name Type Description
event Object
Inherited From:
Source:

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

Called once during component creation to load resources.
Inherited From:
Source:

<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> _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, and "collision" is set to "flipfit", to avoid auto-scrolling on tablets.

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

Create dummy divs for style classes and merge style class values with json . options object
Inherited From:
Source:

<protected> _Render(isResize)

Called to render the component at the current size.
Parameters:
Name Type Description
isResize boolean (optional) Whether it is a resize rerender.
Inherited From:
Source:

<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"], "prop": $(element[i]).prop(attributes[m]["name"])
    }
  }
]
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> _UnregisterChildNode()

Remove all listener references that were attached to the element which includes _activeable, _focusable and hoverable.
Inherited From:
Source:

<protected> _UserOptionChange(key, value, optionMetadata)

Sets an option change that was driven by user gesture. Used in conjunction with _setOption to ensure that the correct optionMetadata flag for writeback is set.
Parameters:
Name Type Description
key string The name of the option to set.
value Object The value to set for the option.
optionMetadata Object The optionMetadata for the optionChange event
Inherited From:
Source: