Package org.primefaces.extensions.model.monacoeditor

Class EditorInlineSuggestOptions

java.lang.Object

org.primefaces.shaded.json.JSONObject

org.primefaces.extensions.model.monacoeditor.EditorInlineSuggestOptions

All Implemented Interfaces:

Serializable

public class EditorInlineSuggestOptions
extends org.primefaces.shaded.json.JSONObject
implements Serializable

Control the behavior and rendering of the inline completions.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.primefaces.shaded.json.JSONObject

NULL

Constructor Summary

Constructors

Constructor	Description
EditorInlineSuggestOptions()

Method Summary

Modifier and Type	Method	Description
String	getMode()
String	getShowToolbar()
Boolean	isEnabled()
Boolean	isKeepOnBlur()
Boolean	isSuppressSuggestions()
EditorInlineSuggestOptions	setEnabled(Boolean enabled)
EditorInlineSuggestOptions	setKeepOnBlur(Boolean keepOnBlur)
EditorInlineSuggestOptions	setMode(String mode)
EditorInlineSuggestOptions	setMode(EInlineSuggestMode mode)
EditorInlineSuggestOptions	setShowToolbar(String showToolbar)
EditorInlineSuggestOptions	setShowToolbar(EShowToolbarMode showToolbar)
EditorInlineSuggestOptions	setSuppressSuggestions(Boolean suppressSuggestions)

Methods inherited from class org.primefaces.shaded.json.JSONObject

accumulate, append, clear, doubleToString, entrySet, get, getBigDecimal, getBigInteger, getBoolean, getDouble, getEnum, getFloat, getInt, getJSONArray, getJSONObject, getLong, getMapType, getNames, getNames, getNumber, getString, has, increment, isDecimalNotation, isEmpty, isNull, keys, keySet, length, names, numberToString, opt, optBigDecimal, optBigInteger, optBoolean, optBoolean, optBooleanObject, optBooleanObject, optDouble, optDouble, optDoubleObject, optDoubleObject, optEnum, optEnum, optFloat, optFloat, optFloatObject, optFloatObject, optInt, optInt, optIntegerObject, optIntegerObject, optJSONArray, optJSONArray, optJSONObject, optJSONObject, optLong, optLong, optLongObject, optLongObject, optNumber, optNumber, optQuery, optQuery, optString, optString, put, put, put, put, put, put, put, put, putOnce, putOpt, query, query, quote, quote, remove, similar, stringToNumber, stringToValue, testValidity, toJSONArray, toMap, toString, toString, valueToString, wrap, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EditorInlineSuggestOptions

public EditorInlineSuggestOptions()

Method Details

isEnabled

public Boolean isEnabled()

Returns:

Enable or disable the rendering of automatic inline completions.

setEnabled

public EditorInlineSuggestOptions setEnabled(Boolean enabled)

Parameters:

enabled - Enable or disable the rendering of automatic inline completions.

Returns:

This same instance, useful for chaining multiple setter methods in one call.

isKeepOnBlur

public Boolean isKeepOnBlur()

Returns:

Does not clear active inline suggestions when the editor loses focus.

setKeepOnBlur

public EditorInlineSuggestOptions setKeepOnBlur(Boolean keepOnBlur)

Parameters:

keepOnBlur - Does not clear active inline suggestions when the editor loses focus.

Returns:

This same instance, useful for chaining multiple setter methods in one call.

getMode

public String getMode()

Returns:

Configures the mode. Use prefix to only show ghost text if the text to replace is a prefix of the suggestion text. Use

invalid reference

subword

to only show ghost text if the replace text is a sub word of the suggestion text. Use

invalid reference

subwordSmart

to only show ghost text if the replace text is a sub word of the suggestion text, but the sub word must start after the cursor position. Defaults to prefix.

setMode

public EditorInlineSuggestOptions setMode(EInlineSuggestMode mode)

Parameters:

mode - Configures the mode. Use prefix to only show ghost text if the text to replace is a prefix of the suggestion text. Use

invalid reference

subword

to only show ghost text if the replace text is a sub word of the suggestion text. Use

invalid reference

subwordSmart

to only show ghost text if the replace text is a sub word of the suggestion text, but the sub word must start after the cursor position. Defaults to prefix.

Returns:

This same instance, useful for chaining multiple setter methods in one call.

setMode

public EditorInlineSuggestOptions setMode(String mode)

Parameters:

mode - Configures the mode. Use prefix to only show ghost text if the text to replace is a prefix of the suggestion text. Use

invalid reference

subword

to only show ghost text if the replace text is a sub word of the suggestion text. Use

invalid reference

subwordSmart

to only show ghost text if the replace text is a sub word of the suggestion text, but the sub word must start after the cursor position. Defaults to prefix.

Returns:

This same instance, useful for chaining multiple setter methods in one call.

getShowToolbar

public String getShowToolbar()

Returns:

Configures whether to show the inline suggest toolbar.

setShowToolbar

public EditorInlineSuggestOptions setShowToolbar(EShowToolbarMode showToolbar)

Parameters:

showToolbar - Configures whether to show the inline suggest toolbar.

Returns:

This same instance, useful for chaining multiple setter methods in one call.

setShowToolbar

public EditorInlineSuggestOptions setShowToolbar(String showToolbar)

Parameters:

showToolbar - Configures whether to show the inline suggest toolbar.

Returns:

This same instance, useful for chaining multiple setter methods in one call.

isSuppressSuggestions

public Boolean isSuppressSuggestions()

setSuppressSuggestions

public EditorInlineSuggestOptions setSuppressSuggestions(Boolean suppressSuggestions)