Class: ojDisplayOptions

Oracle® JavaScript Extension Toolkit (JET)
8.3.0

F24340-01

QuickNav

Fields


ojDisplayOptions

Version:
  • 8.3.0
Module:
  • shared

Module usage

See JET Module Loading for an overview of module usage within JET.

Constructor

new ojDisplayOptions()

Fields

displayOptions :Object

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

The sub-properties of the display-options configure aspects of visual behavior such as where types of information is shown. The values of these sub-properties are specified either as an array of strings or a string. When an array is specified the first display option takes precedence over the second display option 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

displayOptions.converterHint :Array<'placeholder'|'notewindow'|'none'>|'placeholder'|'notewindow'|'none'

Display options for auxiliary 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

displayOptions.helpInstruction :Array<'notewindow'|'none'>|'notewindow'|'none'

Display options for auxiliary help instruction text that determines where it should be displayed in relation to the component.
Default Value:
  • ['notewindow']
Since:
  • 0.7

displayOptions.messages :Array<'inline'|'notewindow'|'none'>|'inline'|'notewindow'|'none'

Display options for auxiliary message text that determines where it should be displayed in relation to the component.
Default Value:
  • ['inline']
Since:
  • 0.7

displayOptions.validatorHint :Array<'notewindow'|'none'>|'notewindow'|'none'

Display options for auxiliary validator hint text that determines where it should be displayed in relation to the component.
Supported Values:
Value Description
none no special label handling by the component.
notewindow shows validation hints in an associated notewindow popup.
Default Value:
  • ['notewindow']
Since:
  • 0.7