Initializer
.ojButton(options)
option()
.
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
options |
Object |
<optional> |
a map of option-value pairs to set on the component |
- Source:
- ojbutton/ojbutton.js, line 29
Examples
Initialize the button with no options specified:
$( ".selector" ).ojButton();
Initialize the button with some options and callbacks specified:
$( ".selector" ).ojButton( { "label": "Copy", "create": function( event, ui ) {} } );
Initialize a push button via the JET ojComponent
binding:
<button id="paste" data-bind="ojComponent: { component: 'ojButton',
label: 'Paste',
create: setupButton }">
Initialize a toggle button via the JET ojComponent
binding:
<label for="check">Toggle</label>
<input type="checkbox" id="check" data-bind="ojComponent: {component: 'ojButton'}"/>
Options
-
#contextMenu :Object
-
JQ selector identifying the JET Menu that the component should launch as a context menu on right-click or Shift-F10. 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.
The JET Menu should be initialized before any component using it as a context menu.
- Default Value:
null
- Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 51
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) : $( ".selector" ).ojFoo({ "contextMenu": "#myMenu" });
Get or set the
contextMenu
option, after initialization:// getter var menu = $( ".selector" ).ojFoo( "option", "contextMenu" ); // setter $( ".selector" ).ojFoo( "option", "contextMenu", ".my-marker-class" );
Set a JET context menu on an ordinary HTML element:
<a href="#" id="myAnchor" contextmenu="myMenu" data-bind="ojContextMenu: {}">Some text
-
#disabled :boolean
-
Disables the button if set to
true
.After create time, the
disabled
state should be set via this API, not by setting the underlying DOM attribute.The 2-way
disabled
binding offered by theojComponent
binding should be used instead of Knockout's built-indisable
andenable
bindings, as the former sets the API, while the latter sets the underlying DOM attribute.- Default Value:
false
- Source:
- ojbutton/ojbutton.js, line 240
Examples
Initialize the button with the
disabled
option specified:$( ".selector" ).ojButton( { "disabled": true } );
Get or set the
disabled
option, after initialization:// getter var disabled = $( ".selector" ).ojButton( "option", "disabled" ); // setter $( ".selector" ).ojButton( "option", "disabled", true );
-
#display :string
-
Whether to display both the label and icons (
"all"
) or just the icons ("icons"
). In the latter case, the label is displayed in a tooltip instead, unless a tooltip was already supplied at create time.The
display
option will be ignored if no icons are specified via theicons
option.- Default Value:
"all"
- Source:
- ojbutton/ojbutton.js, line 266
Supported Values:
Name Type Description "all"
string Display both the label and icons. "icons"
string Display only the icons. Examples
Initialize the button with the
display
option specified:$( ".selector" ).ojButton( { "display": "icons" } );
Get or set the
display
option, after initialization:// getter var display = $( ".selector" ).ojButton( "option", "display" ); // setter $( ".selector" ).ojButton( "option", "display", "icons" );
-
#icons :Object
-
Icons to display in the button. Support is as follows:
- Any combination of start and end icons can be specified, with or without the label (see
display
option). - Icons are supported for push buttons created from buttons and anchors, and for toggle buttons (radios and checkboxes).
- Icons are not supported for push buttons created from inputs of type button, submit, and reset.
The start icon is displayed before the label text (on the left in LTR), and the end icon is displayed after the label (on the right in LTR). In RTL, the positions are reversed.
The value for the
start
andend
properties should be one or more style class names (as seen in the examples) ornull
(the default).- Default Value:
{ start: null, end: null }
- Source:
- ojbutton/ojbutton.js, line 330
Examples
Initialize the button, specifying only one icon:
$( ".selector" ).ojButton({ "icons": { start:'demo-icon-sprite demo-icon-locked' } });
Get or set the
icons
option, after initialization:// getter var icons = $( ".selector" ).ojButton( "option", "icons" ); // setter, specifying both icons: $( ".selector" ).ojButton( "option", "icons", { start: 'demo-icon-sprite demo-icon-gear', end: 'demo-icon-sprite demo-icon-triangle-1-s'} );
- Any combination of start and end icons can be specified, with or without the label (see
-
#label :string
-
Text to show in the button.
When not specified (
null
) at create time, the element's HTML content is used, or itsvalue
attribute if the element is an input element of type button, submit, or reset, or the HTML content of the associated label element if the element is an input of type radio or checkbox.After create time, the label should be set via this API, not by setting the underlying DOM attribute.
The 2-way
label
binding offered by theojComponent
binding should be used instead of Knockout's built-intext
binding, as the former sets the API, while the latter sets the underlying DOM attribute.- Default Value:
null
- Source:
- ojbutton/ojbutton.js, line 297
Examples
Initialize the button with the
label
option specified:$( ".selector" ).ojButton( { "label": "custom label" } );
Get or set the
label
option, after initialization:// getter var label = $( ".selector" ).ojButton( "option", "label" ); // setter $( ".selector" ).ojButton( "option", "label", "custom label" );
-
#menu :Object
-
JQ selector identifying the JET Menu that the button should launch. If specified, the button is a WAI-ARIA-compliant menu button.
By default, menu buttons have a downward pointing "dropdown" arrow for their end icon. See the
icons
option for details.Menu button functionality is supported for Buttons based on button or anchor tags. (Buttons based on input tags either do not support the dropdown icon, or do not make sense for use as a menu button, or both.)
The JET Menu should be initialized before the JET Button that launches it.
- Default Value:
null
- Source:
- ojbutton/ojbutton.js, line 364
Examples
Initialize a menu button:
$( ".selector" ).ojButton({ "menu": "#myMenu" });
Get or set the
menu
option, after initialization:// getter var menu = $( ".selector" ).ojButton( "option", "menu" ); // setter $( ".selector" ).ojButton( "option", "menu", ".my-marker-class" );
-
#rootAttributes :Object|undefined
-
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 root element at creation time.
The specified
class
andstyle
are appended to the current class and style, respectively. All other attributes overwrite any existing value.Setting this option after component creation has no effect.
- Default Value:
undefined
- Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 77
Example
Initialize a JET component, specifying a set of attributes to be set on the component's root DOM element:
$( ".selector" ).ojFoo({ "rootAttributes": { 'id': 'myId', 'style': 'max-width:100%; color:blue;', 'class': 'my-class' }});
Events
-
#create
-
Triggered when the button is created.
- Source:
- ojbutton/ojbutton.js, line 368
Properties:
Name Type Description event
Event jQuery
event objectui
Object Empty object included for consistency with other events Examples
Initialize the button with the
create
callback specified:$( ".selector" ).ojButton({ "create": function( event, ui ) {} });
Bind an event listener to the
ojcreate
event:$( ".selector" ).on( "ojcreate", function( event, ui ) {} );
Methods
-
#destroy()
-
Removes the button functionality completely. This will return the element back to its pre-init state.
This method does not accept any arguments.
- Source:
- ojbutton/ojbutton.js, line 1288
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
destroy
method:$( ".selector" ).ojButton( "destroy" );
-
#getNodeBySubId(locator) → {Element|null}
-
Return the subcomponent node represented by the documented locator attribute values.
Parameters:
Name Type Description locator
Object An Object containing at minimum a subId property whose value is a string, documented by the component, that allows the component to look up the subcomponent associated with that string. It contains: component: optional component name - in the future there may be more than one component contained within a page element
subId: the string, documented by the component, that the component expects in getNodeBySubId to locate a particular subcomponent.
- Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 526
Returns:
the subcomponent located by the subId string passed in locator, if found.- Type
- Element | null
-
#getSubIdByNode(node) → {string|null}
-
Return the subId string for the given child DOM node
Parameters:
Name Type Description node
Element child DOM node - Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 548
Returns:
- the subId for the DOM node or null when none is found- Type
- string | null
-
#option(optionName, value) → {Object|undefined}
-
This method has several overloads, which gets and set component options.
The first overload accepts a single
optionName
param as a string, and returns the current value of that option.The second overload accepts two params, an
optionName
string and a new value to which that option will be set.The third overload accepts no params, and returns a map of key/value pairs representing all the component options and their values.
The fourth overload accepts a single map of option-value pairs to set on the component.
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:
- ojcomponentcore/jqueryui-base.js, line 600
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:
var isDisabled = $( ".selector" ).ojFoo( "option", "disabled" ); // Foo is Button, Menu, etc.
Second overload: set one option:
$( ".selector" ).ojFoo( "option", "disabled", true ); // Foo is Button, Menu, etc.
Third overload: get all options:
var options = $( ".selector" ).ojFoo( "option" ); // Foo is Button, Menu, etc.
Fourth overload: set one or more options:
$( ".selector" ).ojFoo( "option", { disabled: true } ); // Foo is Button, Menu, etc.
-
#refresh()
-
Refreshes the button. JET components require a
refresh()
after a supported DOM change is made that affects the component, of which the component would otherwise be unaware.This method calls
baseComponent.refresh()
, but doesn't currently do anything Button-specific. Note that anything having a JS API, such as the Button's label, disabled state, and checked state, must be set via the API, not by mutating the DOM and callingrefresh()
. (For the checked state, see Buttonset'schecked
option.)- Source:
- ojbutton/ojbutton.js, line 810
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" ).ojButton( "refresh" );
-
#widget() → {jQuery}
-
Returns a
jQuery
object containing the element visually representing the button. For checkboxes and radios, this is the label, not the input.This method does not accept any arguments.
- Source:
- ojbutton/ojbutton.js, line 697
Returns:
the button- Type
- jQuery
Example
Invoke the
widget
method:var widget = $( ".selector" ).ojButton( "widget" );
Non-public Methods
Note: Extending JET components is not currently supported. Thus, non-public methods are for internal use only.
-
<protected> #_AfterCreate()
-
This method is called after
_ComponentCreate
. 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 therootAttributes
andcontextMenu
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:
- ojcomponentcore/jqueryui-base.js, line 292
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining. -
<protected> #_ComponentCreate()
-
All component create-time initialization lives in this method, except the logic that specifically needs to live in
_InitOptions
or_AfterCreate
, per the documentation for those methods. All DOM creation must happen here, since the intent of_AfterCreate
is to contain superclass logic that must run after that DOM is created.Overrides of this method should call
this._super
first.- Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 266
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining. -
<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 from
_create()
andrefresh()
, 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 if directional islands and component reparenting (e.g. popups) should coexist.)
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:
- ojcomponentcore/jqueryui-base.js, line 888
Returns:
the reading direction, either"ltr"
or"rtl"
- Type
- string
-
<protected> #_GetSavedAttributes(element) → {Object}
-
Gets the saved attributes for the provided element. This is usually the original list of attributes set on the element.
Parameters:
Name Type Description element
Object jQuery selection, should be a single entry - Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 359
Returns:
savedAttributes - attributes that were saved for this element.- Type
- Object
-
<protected> #_InitOptions()
-
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. No other work should be done in this method. See below for details.
Overrides of this method should call
this._super
first.Usage:
- If the component has an option like
disabled
that can be set from the DOM at create time, then the "get from DOM" logic should live in this method. E.g. a typical override might say "if thedisabled
option still has its initial value ofundefined
(i.e., the option has not been set), then get the DOM property and set it on the option." (See also next bullet.) - For attributes that live on the component's root node, keep in mind that anything specified via
the
rootAttributes
option will not be placed on the DOM until_AfterCreate
. So when getting attributes from the root node, components must first look in therootAttributes
option, and then, only if the attribute is not found there, look on the component root (if it already exists). - For options that, unlike
disabled
, have no corresponding DOM property, and are not otherwise set from the DOM, there is nothing to do in this method. - Do NOT set anything on the DOM in this method (like the resolved
disabled
value, or anyrootAttributes
values). The resolved option values should be set on the DOM later, in_ComponentCreate
, and therootAttributes
values are set inbaseComponent._AfterCreate
.
- Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 249
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining. - If the component has an option like
-
<protected> #_RestoreAttributes()
-
Restores the saved element's attributes
- Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 385
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining. -
<protected> #_SaveAttributes(element)
-
Saves the element's attributes within an internal variable to be reset during the destroy function 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:
- ojcomponentcore/jqueryui-base.js, line 320
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining. -
<protected> #_SetRootAttributes()
-
Reads the
rootAttributes
option, and sets the root attributes on the component's root DOM element.class
andstyle
are appended to the current class and style, respectively. All other attributes overwrite any existing value.- Inherited From:
- Source:
- ojcomponentcore/jqueryui-base.js, line 103
Returns:
When called via the public jQuery syntax, this method returns the object on which it was called, to facilitate method chaining.