Class: ojDisplayOptions

Oracle® JavaScript Extension Toolkit (JET)
9.0.0

F24343-01

QuickNav

Fields

ojDisplayOptions

Version:
  • 9.0.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 whether or not it should be displayed.

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 you don't want to show the converter hint, set the display-options.converter-hint to 'none'.

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 whether or not it should be displayed. If you don't want to show the converter hint, set it to 'none'. Otherwise, in the Redwood theme it will show according to the user-assistance-density options.
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.
Deprecated:
Since Description
9.0.0 If you want none, remove help-instruction attribute.
Default Value:
  • ['notewindow']
Since:
  • 9.0.0

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

Display options for auxiliary message text that determines whether or not it should be displayed. If you don't want to show messages, set it to 'none'. Otherwise, in the Redwood theme it will show according to the user-assistance-density options.
Default Value:
  • ['inline']
Since:
  • 0.7

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

Display options for auxiliary validator hint text that determines whether or not it should be displayed. If you don't want to show the validator hint, set it to 'none'. Otherwise, in Redwood theme it will show according to the user-assistance-density options.
Default Value:
  • ['notewindow']
Since:
  • 0.7