Element: <oj-label-value>

Oracle® JavaScript Extension Toolkit (JET)
5.2.0
E97691-01

JET Custom Elements

JET components are implemented as custom HTML elements. In addition to the component attributes documented in this page, JET components also support standard HTML global attributes like id and aria-label.

The JET data binding syntax can be used to define both component and global attributes through the use of dynamically evaluated expressions. All attributes (component and global) support attribute-level binding by prefixing the attribute name with ":" (e.g. :id="[...]"). When using attribute-level binding, all expression values are treated as strings. Additionally, component attributes support property-level binding by using the attribute name directly with no ":" prefix. When using property-level binding, the expressions should evaluate to the types documented by the corresponding attributes. Property-level binding is strongly recommended over attribute-level binding for component attributes.

A detailed description of working with custom HTML elements can be found in: JET Custom Element Usage.

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

Version:

5.2.0

Since:

5.1.0

Module:

ojlabelvalue

JET LabelValue

The oj-label-value element is used to group label(s) and value(s) elements into a single layout element that is most commonly a child of oj-form-layout. This component gives some flexibility to what shows up in the label portion and what shows up in the value portion of an oj-form-layout element sequence of laid out elements (most commonly which are label/value pairs). The 'label' and 'value' slots are used to add elements to either the 'label' or 'value' parts of a label/value form layout item.

For example:


<oj-form-layout max-columns='2' label-edge='start' label-width="50%">
  <oj-label-value>
    <my-label slot="label" for="my1"></my-label> 
    <my-input slot="value" id="my1"></my-input>
  </oj-label-value>
  <oj-label-value>
    <my-label slot="label" for="my2"></my-label> 
  </oj-label-value>
  <oj-label-value>
    <my-input slot="value" id="my2"></my-input>
  </oj-label-value>
</oj-form-layout>

Any slot child elements not in either a 'label' or 'value' slot will be removed from the DOM. This includes the default slot.

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.

Attributes

label-edge :string

Specifies how the label is aligned with its value component.

If the value is 'inherit', it will inherit label-edge from its closest custom element ancestor element. If the ancestor doesn't have a label-width attribute, the default is "top".

Supported Values:

Name	Type	Description
`"inherit"`	string	Label will inherit label-edge from its closest custom element ancestor element.
`"start"`	string	Label is inline with the start of its value component
`"top"`	string	Label is on top of its value component

Default Value:

"inherit"

Names

Item	Name
Property	`labelEdge`
Property change event	`labelEdgeChanged`
Property change listener attribute (must be of type function)	`on-label-edge-changed`

Examples

Initialize the oj-label-value with the label-edge attribute specified:

<oj-label-value label-edge="top">
  <oj-input-text id="inputcontrol" required value="text" label-hint="input 1"></oj-input-text>
</oj-label-value>

Get or set the labelEdge property after initialization:

// getter
var edge = myLabelValue.labelEdge;

// setter
myLabelValue.labelEdge = 'start';

label-width :string

Specifies the label width.

This can be any legal CSS width or 'inherit', which will inherit label-width from its closest custom element ancestor element. If the value is "inherit" and ancestor doesn't have a label-width attribute, the default is "33%".

Default Value:

"inherit"

Names

Item	Name
Property	`labelWidth`
Property change event	`labelWidthChanged`
Property change listener attribute (must be of type function)	`on-label-width-changed`

Examples

Initialize the oj-form-layout with the label-width attribute specified:

<oj-form-layout label-width="50%">
  <oj-input-text id="inputcontrol" required value="text" label-hint="input 1"></oj-input-text>
  <oj-text-area id="textareacontrol" value='text' rows="6" label-hint="textarea"></oj-text-area>
</oj-form-layout>

Get or set the labelWidth property after initialization:

// getter
var width = myLabelValue.labelWidth;

// setter
myLabelValue.labelWidth = '60px';

Methods

getProperty(property) → {*}

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.

Returns:

Type: *

Example

Get a single subproperty of a complex property:

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

refresh() → {void}

Refreshes the visual state of the component.

Returns:

Type: void

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.

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`	*	The new value to set the property to.

Returns:

Type: void

Example

Set a single subproperty of a complex property:

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