Element: <oj-radioset>

<oj-radioset id="colorRadio" value="{{currentColor}}">
  <oj-option value="blue">Blue</oj-option>
  <oj-option value="green">Green</oj-option>
</oj-radioset>

<label id="grouplabel">Greetings</label>
<oj-radioset id="radioset" aria-labelledby="grouplabel" value="{{currentGreeting}}">
  <input id="helloid" value="hello" type="radio" name="greetings"/>
  <label for="helloid"/>Hello</label>
  <input id="bonjourid" value="bonjour" type="radio" name="greetings"/>
  <label for="bonjourid"/>Bonjour</label>
  <input id="ciaoid" value="ciao" type="radio" name="greetings"/>
  <label for="ciaoid"/>Ciao</label>
<oj-radioset>


// set the value to "ciao". (The 'ciao' radio will be selected)
myComp.value = "ciao";

<oj-label id="grouplabel">Time</oj-label>
<oj-radioset id="radioset" value="{{radiosetValue}}" 
                labelled-by="grouplabel">
  <oj-option id="morningid" value="morning">Morning</oj-option>
  <oj-option id="nightid" value="night">Night</oj-option>
</oj-radioset>

Slots

JET elements can have up to two types of child content:

• Any child element with a slot attribute will be moved into that named slot, e.g. <span slot='startIcon'>...</span>. All supported named slots are documented below. Child elements with unsupported named slots will be removed from the DOM.
• Any child element lacking a slot attribute will be moved to the default slot, also known as a regular child.

contextMenu

The contextMenu slot is set on the oj-menu within this element. This is used to designate the JET Menu that this 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 JET Menu specified in this slot.

The application can register a listener for the Menu's ojBeforeOpen 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 ojBeforeOpen 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.

Example

Initialize the component with a context menu:

<oj-some-element>
    <-- use the contextMenu slot to designate this as the context menu for this component -->
    <oj-menu slot="contextMenu" style="display:none" aria-label="Some element's context menu">
...
    </oj-menu>
</oj-some-element>

Attributes

(nullable) described-by :string

It is used to establish a relationship between this component and another element. Typically this is not used by the application developer, but by the oj-label custom element's code. One use case is where the oj-label custom element code writes described-by on its form component for accessibility reasons. To facilitate correct screen reader behavior, the described-by attribute is copied to the aria-describedby attribute on the component's dom element.

Since:

• 4.0.0

Names

Item	Name
Property	describedBy
Property change event	describedByChanged
Property change listener attribute (must be of type function)	on-described-by-changed

Examples

Initialize component with the described-by attribute specified:

<oj-some-element described-by="someId"></oj-some-element>

Get or set the describedBy property after initialization:

// getter
var descById = myComp.describedBy;

// setter
myComp.describedBy = "someId";

disabled :boolean|null

Disabled true disables the component and disables all the inputs/labels. Disabled false enables the component, and leaves the inputs' disabled property as it is in the dom.

Default Value:

• false

Names

Item	Name
Property	disabled
Property change event	disabledChanged
Property change listener attribute (must be of type function)	on-disabled-changed

Examples

Initialize component with disabled attribute:

<oj-radioset disabled>
  <oj-option value="blue">Blue</oj-option>
</oj-radioset>

Get or set the disabled property after initialization:

// getter
var disabled = myComp.disabled;

// setter
myComp.disabled = false;

display-options :Object

Display options for auxilliary content that determines where it should be displayed in relation to the component.

The types of messaging content for which display options can be configured include converterHint, helpInstruction, messages, and validatorHint.
The display options for each type is specified either as an array of strings or a string. When an array is specified the first display option takes precedence over the second and so on.

When display-options changes due to programmatic intervention, the component updates its display to reflect the updated choices. For example, if 'help.instruction' property goes from 'notewindow' to 'none' then it no longer shows in the notewindow.

A side note: help.instruction and message detail text can include formatted HTML text, whereas hints and message summary text cannot. If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there. To format the help.instruction, you could do this:

<html>Enter <b>at least</b> 6 characters</html>

Since:

• 0.7

Names

Item	Name
Property	displayOptions
Property change event	displayOptionsChanged
Property change listener attribute (must be of type function)	on-display-options-changed

Examples

Override default values for display-options for one component:

// In this example, the display-options are changed from the defaults.
// The 'converterHint' is none, the 'validatorHint' is none and the 'helpInstruction' is none,
// so only the 'messages' will display in its default state.
//
<oj-some-element display-options='{"converterHint": "none",
                                    "validatorHint": "none",
                                    "helpInstruction": "none"}'></oj-some-element>

Get or set the displayOptions property after initialization:

// Get one subproperty
var hint = myComp.displayOptions.converterHint;

// Set one, leaving the others intact. Use the setProperty API for 
// subproperties so that a property change event is fired.
myComp.setProperty("displayOptions.converterHint", "none");

// get all
var options = myComp.displayOptions;

// set all.  Must list every resource key, as those not listed are lost.
myComp.displayOptions = {converterHint: "none", validatorHint: "none", helpInstruction: "none"};

display-options.converter-hint :(Array.<('placeholder'|'notewindow'|'none')>|'placeholder'|'notewindow'|'none')

Display options for auxilliary converter hint text that determines where it should be displayed in relation to the component. When there is already a placeholder set on the component, the converter hint falls back to display type of 'notewindow'.

Default Value:

• ['placeholder','notewindow']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.converterHint

display-options.help-instruction :(Array.<('notewindow'|'none')>|'notewindow'|'none')

Display options for auxilliary help instruction text that determines where it should be displayed in relation to the component.

Default Value:

• ['notewindow']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.helpInstruction

display-options.messages :(Array.<('inline'|'notewindow'|'none')>|'inline'|'notewindow'|'none')

Display options for auxilliary message text that determines where it should be displayed in relation to the component.

Default Value:

• ['inline']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.messages

display-options.validator-hint :(Array.<('notewindow'|'none')>|'notewindow'|'none')

Display options for auxilliary validator hint text that determines where it should be displayed in relation to the component.

Default Value:

• ['notewindow']

Since:

• 0.7

Names

Item	Name
Property	displayOptions.validatorHint

help :Object

Form component help information.

The properties supported on the help option are:

Properties:

Name	Type	Argument	Description
instruction	string	<optional>	this represents advisory information for the component The default value is null.

Since:

• 0.7

Names

Item	Name
Property	help
Property change event	helpChanged
Property change listener attribute (must be of type function)	on-help-changed

help.instruction :string

Represents advisory information for the component, such as would be appropriate for a tooltip.

When help.instruction is present it is by default displayed in the notewindow, or as determined by the 'helpInstruction' property set on the displayOptions attribute. When the help.instruction property changes the component refreshes to display the updated information.

JET takes the help instruction text and creates a notewindow with the text. The help instruction only shows up as a tooltip on mouse over, not on keyboard and not in a mobile device. So help instruction would only be for text that is not important enough to show all users, or for text that you show the users in another way as well, like in the label. Also you cannot theme the native browser's title window like you can the JET notewindow, so low vision users may have a hard time seeing it. For these reasons, the JET EditableValue components do not use the HTML's title attribute.

To include formatted text in the help.instruction, format the string using html tags. For example the help.instruction might look like:

<oj-some-element help.instruction="<html>Enter <b>at least</b> 6 characters</html>"></oj-some-element>

If you use formatted text, it should be accessible and make sense to the user if formatting wasn't there.

Default Value:

• ""

Since:

• 4.0.0

Names

Item	Name
Property	help.instruction

Examples

Initialize the component with the help.instruction sub-attribute:

<oj-some-element help.instruction="some tooltip"></oj-some-element>
 

Get or set the help.instruction property after initialization:

// Get one subproperty
var instr = myComp.help.instruction;

// Set one subproperty, leaving the others intact. Use the setProperty API for 
// subproperties so that a property change event is fired.
myComponent.setProperty('help.instruction', 'some new value');

// Get all
var values = myComponent.help;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.help = {
  instruction: 'some new value'
};

help-hints :Object

Represents hints for oj-form-layout element to render help information on the label of the editable component.

This is used only if the editable component is added as a direct child to an oj-form-layout element, and the labelHint property is also specified.

The helpHints object contains a definition property and a source property.

• definition - hint for help definition text.
• source - hint for help source URL.

Since:

• 4.1.0

Names

Item	Name
Property	helpHints
Property change event	helpHintsChanged
Property change listener attribute (must be of type function)	on-help-hints-changed

Examples

Initialize the component with help hints:

<!-- Using dot notation -->
<oj-some-element help-hints.definition='some value' help-hints.source='some-url'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element help-hints='{"definition":"some value", "source":"some-url"}'></oj-some-element>

Get or set the helpHints property after initialization:

// Get one
var value = myComponent.helpHints.definition;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('helpHints.definition', 'some new value');

// Get all
var values = myComponent.helpHints;

// Set all.  Must list every subproperty, as those not listed are lost.
myComponent.helpHints = {
    definition: 'some new value',
    source: 'some-new-url'
};

help-hints.definition :string

Hint for help definition text associated with the label.

It is what shows up when the user hovers over the help icon, or tabs into the help icon, or press and holds the help icon on a mobile device. No formatted text is available for help definition attribute.

See the help-hints attribute for usage examples.

Default Value:

• ""

Since:

• 4.1.0

Names

Item	Name
Property	helpHints.definition

help-hints.source :string

Hint for help source URL associated with the label.

If present, a help icon will render next to the label. For security reasons we only support urls with protocol http: or https:. If the url doesn't comply we ignore it and throw an error. Pass in an encoded URL since we do not encode the URL.

See the help-hints attribute for usage examples.

Default Value:

• ""

Since:

• 4.1.0

Names

Item	Name
Property	helpHints.source

label-hint :string

Represents a hint for oj-form-layout element to render a label on the editable component.

This is used only if the editable component is added as a direct child to an oj-form-layout element.

When labelHint is present it gives a hint to the oj-form-layout element to create an oj-label element for the editable component. When the labelHint property changes oj-form-layout element refreshes to display the updated label information.

Default Value:

• ""

Since:

• 4.1.0

Names

Item	Name
Property	labelHint
Property change event	labelHintChanged
Property change listener attribute (must be of type function)	on-label-hint-changed

Examples

Initialize the component with the label-hint attribute specified:

<oj-some-element label-hint='input label'></oj-some-element>

Get or set the labelHint property after initialization:

// getter
var value = myComponent.labelHint;

// setter
myComponent.labelHint = 'some new value'

labelled-by :string|null

It is used to establish a relationship between this component and another element. A common use is to tie the oj-label and the oj-radioset together. The oj-label custom element has an id, and you use the labelled-by attribute to tie the two components together.

Names

Item	Name
Property	labelledBy
Property change event	labelledByChanged
Property change listener attribute (must be of type function)	on-labelled-by-changed

Examples

Initialize component with labelled-by attribute:

<oj-label id="labelId">Name:</oj-label>
<oj-radioset labelled-by="labelId">
  <oj-option value="blue">Blue</oj-option>
</oj-radioset>

Get or set the labelledBy property after initialization:

// getter
var disabled = myComp.labelledBy;

// setter
myComp.labelledBy = "labelId";

messages-custom :Array.<Object>

List of messages an app would add to the component when it has business/custom validation errors that it wants the component to show. This allows the app to perform further validation before sending data to the server. When this option is set the message shows to the user right away. To clear the custom message, set messagesCustom back to an empty array.

Each message in the array is an object that duck types oj.Message. See oj.Message for details.

See the Validation and Messages section for details on when the component clears messagesCustom; for example, when full validation is run.

Default Value:

• []

Supports writeback:

• true

Since:

• 0.7

Names

Item	Name
Property	messagesCustom
Property change event	messagesCustomChanged
Property change listener attribute (must be of type function)	on-messages-custom-changed

Examples

Get or set the messagesCustom property after initialization:

// getter
var customMsgs = myComp.messagesCustom;

// setter
myComp.messagesCustom = [{summary:"hello", detail:"detail", severity:oj.Message.SEVERITY_LEVEL.INFO}];

Set messagesCustom when there are cross-validation errors:

--- HTML ---
<oj-some-element messages-custom='{{messagesCustom}}'></oj-some-element> 

--- ViewModel code ---
self.messagesCustom = ko.observableArray([]);

// the app's function that gets called when the user presses the submit button
if (!myValidateCrossValidationFields())
{
  // the app adds a custom messages to the component and it is displayed right away
  var msgs = [];
  msgs.push({'summary':'Cross field error', 'detail':'Field 1 needs to be less than Field 2'});
  self.messagesCustom(msgs);
}
else
{
  // submit data to the server
}

required :boolean

Whether the component is required or optional. When required is set to true, an implicit required validator is created using the validator factory - oj.Validation.validatorFactory(oj.ValidatorFactory.VALIDATOR_TYPE_REQUIRED).createValidator(). Translations specified using the translations.required option and the label associated with the component, are passed through to the options parameter of the createValidator method.

When required option changes due to programmatic intervention, the component may clears message and run validation, based on the current state it's in.

Running Validation

• if component is valid when required is set to true, then it runs deferred validation on the property value. This is to ensure errors are not flagged unnecessarily.
• if component is invalid and has deferred messages when required is set to false, then component messages are cleared but no deferred validation is run.
• if component is invalid and currently showing invalid messages when required is set, then component messages are cleared and normal validation is run using the current display value.
  • if there are validation errors, then value property is not updated and the error is shown.
  • if no errors result from the validation, the value property is updated; page author can listen to the optionChange event to clear custom errors.

Clearing Messages

• Only messages created by the component are cleared.
• messagesCustom option is not cleared.

This property set to false implies that a value is not required to be provided by the user. This is the default. This property set to true implies that a value is required to be provided by user and the input's label will render a required icon. Additionally a required validator - oj.RequiredValidator - is implicitly used if no explicit required validator is set. An explicit required validator can be set by page authors using the validators option. When the option is not set, the element's required property is used as its initial value if it exists.

Default Value:

• false

Since:

• 0.7

See:

• #translations

Names

Item	Name
Property	required
Property change event	requiredChanged
Property change listener attribute (must be of type function)	on-required-changed

Examples

Initialize the component with the required attribute:

<oj-radioset required>
  <oj-option value="blue">Blue</oj-option>
</oj-radioset>

Customize messages and hints used by implicit required validator when required option is set:

<oj-radioset required value="{{colors}}"
                   translations='{"required":
                                   {"hint": "custom: check at least one value",
                                    "messageSummary": "custom: \'{label}\' is Required",
                                    "messageDetail", "custom: please check at least one value for \'{label}\'"}}'>
  <oj-option value="blue">Blue</oj-option>
</oj-radioset>

Get or set the required property after initialization:

// getter
var required = myComp.required;

// setter
myComp.required = false;

translations :Object|null

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 the component does not contain any translatable resource, the default value of this attribute will be null. If not, an object containing all resources relevant to the component.

If this component has translations, their documentation immediately follows this doc entry.

Names

Item	Name
Property	translations
Property change event	translationsChanged
Property change listener attribute (must be of type function)	on-translations-changed

Examples

Initialize the component, overriding some translated resources and leaving the others intact:

<!-- Using dot notation -->
<oj-some-element translations.some-key='some value' translations.some-other-key='some other value'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element translations='{"someKey":"some value", "someOtherKey":"some other value"}'></oj-some-element>

Get or set the translations property after initialization:

// Get one
var value = myComponent.translations.someKey;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('translations.someKey', 'some value');

// Get all
var values = myComponent.translations;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.translations = {
    someKey: 'some value',
    someOtherKey: 'some other value'
};

(nullable) translations.required :Object

Provides properties to customize the summary, detail and hint text used by the implicit required validator associated to any editable component that supports the required option.

See the translations attribute and required option for usage examples.

Since:

• 0.7

Names

Item	Name
Property	translations.required

(nullable) translations.required.hint :string

Hint text used by required validation error.

See the translations attribute for usage examples.

Default Value:

• ""

Since:

• 0.7

See:

• oj.RequiredValidator

Names

Item	Name
Property	translations.required.hint

(nullable) translations.required.message-detail :string

Message text that describes the details of the required validation error.

See the translations attribute for usage examples.

Default Value:

• ""

Since:

• 0.7

See:

• oj.RequiredValidator

Names

Item	Name
Property	translations.required.messageDetail

(nullable) translations.required.message-summary :string

Message text for summarizing a required validation error.

See the translations attribute for usage examples.

Default Value:

• ""

Since:

• 0.7

See:

• oj.RequiredValidator

Names

Item	Name
Property	translations.required.messageSummary

(readonly) valid :string

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

The current valid state of the component. It is evaluated on initial render. It is re-evaluated

• after validation is run (full or deferred)
• when messagesCustom is updated, since messagesCustom can be added by the app developer any time.
• when showMessages() is called. Since showMessages() moves the hidden messages into messages shown, if the valid state was "invalidHidden" then it would become "invalidShown".
• when the required property has changed. If a component is empty and has required set, the valid state may be "invalidHidden" (if no invalid messages are being shown as well). If required property is removed, the valid state would change to "valid".

Note: New valid states may be added to the list of valid values in future releases. Any new values will start with "invalid" if it is an invalid state, "pending" if it is pending state, and "valid" if it is a valid state.

Supported Values:

Name	Type	Description
"invalidHidden"	string	The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity "error" or higher.
"invalidShown"	string	The component has invalid messages showing. An invalid message is one with severity "error" or higher.
"pending"	string	The component is waiting for the validation state to be determined. The "pending" state is set at the start of the convert/validate process.
"valid"	string	The component is valid

Supports writeback:

• true

Since:

• 4.2.0

Names

Item	Name
Property	valid
Property change event	validChanged
Property change listener attribute (must be of type function)	on-valid-changed

Examples

Get valid attribute, after initialization:

// Getter:
var valid = myComp.valid;

Set the on-valid-changed listener so you can do work in the ViewModel based on the valid property:

<oj-some-element id='username' on-valid-changed='[[validChangedListener]]'>
</oj-some-element>
<oj-some-element id='password' on-valid-changed='[[validChangedListener]]'>
</oj-some-element>
<oj-button disabled='[[componentDisabled]]' on-click='[[submit]]'>Submit</oj-button>
-- ViewModel --
self.validChangedListener = function (event) {
  var enableButton;
  var usernameValidState;
  var passwordValidState;
  
  // update the button's disabled state.
  usernameValidState = document.getElementById("username").valid;
  passwordValidState = document.getElementById("password").valid;
  
  // this updates the Submit button's disabled property's observable based
  // on the valid state of two components, username and password.
  // It is up to the application how it wants to handle the �pending� state 
  // but we think that in general buttons don�t need to be 
  // enabled / disabled based on the "pending" state.
  enableButton = 
   (usernameValidState !== "invalidShown") &&
   (passwordValidState !== "invalidShown");
  self.componentDisabled(!enableButton);;
};

value :any

The value of the component.

When value option changes due to programmatic intervention, the component always clears all messages and runs deferred validation, and always refreshes UI display value.

Clearing Messages

• All messages are cleared. This includes messagesCustom property.

Running Validation

• component always runs deferred validation

Default Value:

• null

Supports writeback:

• true

Names

Item	Name
Property	value
Property change event	valueChanged
Property change listener attribute (must be of type function)	on-value-changed

Examples

Initialize component with value attribute:

<oj-radioset value="coffee">
  <oj-option value="coffee">Coffee</oj-option>
  <oj-option value="tea">Tea</oj-option>
</oj-radioset>

Get or set the value property after initialization:

// getter
var val = myComp.value;

// setter
myComp.value = "tea";

Events

ojAnimateEnd

Triggered when a default animation has ended.

Properties:

All of the event payloads listed below can be found under event.detail.

Name	Type	Description
action	string	The action that triggers the animation. Supported values are: "inline-open" - when an inline message container opens or increases in size "inline-close" - when an inline message container closes or decreases in size "notewindow-open" - when a note window opens "notewindow-close" - when a note window closes
element	Element	The element being animated.

Since:

• 4.0.0

Examples

Define an event listener for the ojAnimateEnd event to add any processing after the end of "inline-open" animation:

var listener = function( event )
{
  // Check if this is the end of "inline-open" animation for inline message
  if (event.detail.action == "inline-open") {
    // Add any processing here
  }
};

Specify an ojAnimateEnd listener via the DOM attribute:

<oj-radioset on-oj-animate-end='[[listener]]'></oj-radioset>

Specify an ojAnimateEnd listener via the JavaScript property:

myRadioset.onOjAnimateEnd = listener;

Add an ojAnimateEnd listener via the addEventListener API:

myRadioset.addEventListener('ojAnimateEnd', listener);

ojAnimateStart

Triggered when a default animation is about to start on an element owned by the component.

The default animation can be cancelled by calling event.preventDefault, followed by a call to event.detail.endCallback. event.detail.endCallback should be called immediately after event.preventDefault if the application merely wants to cancel animation, or it should be called when the custom animation ends if the application is invoking another animation function. Failure to call event.detail.endCallback may prevent the component from working properly.

For more information on customizing animations, see the documentation of oj.AnimationUtils.

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

// default animations for "notewindow" display option
$noteWindowOpenAnimation: (effect: "zoomIn", transformOrigin: "#myPosition") !default;
$noteWindowCloseAnimation: (effect: "none") !default;

// default animations for "inline" display option
$messageComponentInlineOpenAnimation: (effect: "expand", startMaxHeight: "#oldHeight") !default;
$messageComponentInlineCloseAnimation: (effect: "collapse", endMaxHeight: "#newHeight") !default;

Properties:

All of the event payloads listed below can be found under event.detail.

Name	Type	Description
action	string	The action that triggers the animation. Supported values are: "inline-open" - when an inline message container opens or increases in size "inline-close" - when an inline message container closes or decreases in size "notewindow-open" - when a note window opens "notewindow-close" - when a note window closes
element	Element	The element being animated.
endCallback	function():void	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.

Since:

• 4.0.0

Examples

Define an event listener for the ojAnimateStart event to override the default "inline-open" animation:

var listener = function( event )
  {
    // Change the "inline-open" animation for inline message
    if (event.detail.action == "inline-open") {
      // Cancel default animation
      event.preventDefault();
      // Invoke new animation and call endCallback when the animation ends
      oj.AnimationUtils.fadeIn(event.detail.element).then(event.detail.endCallback);
    }
  };

Define an event listener for the ojAnimateStart event to cancel the default "notewindow-close" animation:

var listener = function( event )
  {
    // Change the "notewindow-close" animation for note window
    if (ui.action == "notewindow-close") {
      // Cancel default animation
      event.preventDefault();
      // Call endCallback immediately to indicate no more animation
      event.detail.endCallback();
  };

Specify an ojAnimateStart listener via the DOM attribute:

<oj-radioset on-oj-animate-start='[[listener]]'></oj-radioset>

Specify an ojAnimateStart listener via the JavaScript property:

myRadioset.onOjAnimateStart = listener;

Add an ojAnimateStart listener via the addEventListener API:

myRadioset.addEventListener('ojAnimateStart', listener);

Methods

getProperty(property) → {any}

Retrieves a value for a property or a single subproperty for complex properties.

Parameters:

Name	Type	Description
property	string	The property name to get. Supports dot notation for subproperty access.

Since:

• 4.0.0

Returns:

Type

any

Example

Get a single subproperty of a complex property:

var subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');

refresh() → {void}

Refreshes the radioset

A refresh() is required when a radioset is programatically changed, like in the following circumstances:

• After radios are added or removed or modified (without using ojRadioset) in the DOM.

Returns:

Type

void

Example

Invoke the refresh method:

myComp.refresh();

reset() → {void}

Resets the component by clearing all messages and messages attributes - messagesCustom - and updates the component's display value using the attribute value. User entered values will be erased when this method is called.

Since:

• 0.7

Returns:

Type

void

Example

Reset component

myComp.reset(); 

setProperties(properties) → {void}

Performs a batch set of properties.

Parameters:

Name	Type	Description
properties	Object	An object containing the property and value pairs to set.

Since:

• 4.0.0

Returns:

Type

void

Example

Set a batch of properties:

myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});

setProperty(property, value) → {void}

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a [property]Changed event.

Parameters:

Name	Type	Description
property	string	The property name to set. Supports dot notation for subproperty access.
value	any	The new value to set the property to.

Since:

• 4.0.0

Returns:

Type

void

Example

Set a single subproperty of a complex property:

myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");

showMessages() → {void}

Takes all deferred messages and shows them. It then updates the valid property; e.g., if the valid state was "invalidHidden" before showMessages(), the valid state will become "invalidShown" after showMessages().

If there were no deferred messages this method simply returns.

Since:

• 0.7

Returns:

Type

void

Example

Display all messages including deferred ones.

myComp.showMessages();

validate() → {Promise.<string>}

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Validates the component's display value using all validators registered on the component and updates the value option by performing the following steps.

1. All messages are cleared, including custom messages added by the app.
2. The implicit required validator is run if the component is marked required.
3. At the end of validation if there are errors, the messages are shown. If there were no errors, then the value property is updated.

Since:

• 4.0.0

Returns:

Promise resolves to "valid" if the component passed all validations. The Promise resolves to "invalid" if there were validation errors.

Type

Promise.<string>

Examples

Validate component using its current value.

myComp.validate();

Validate component and use the Promise's resolved state.

myComp.validate().then(
 function(result) {
   if(result === "valid")
   {
     submitForm();
   }
 });