Options.OptionsBuilder (addon 2.0.0 API)

java.lang.Object
- com.byteowls.vaadin.mediumeditor.options.AbstractBuilder<Options>
- - com.byteowls.vaadin.mediumeditor.options.Options.OptionsBuilder

Enclosing class:: Options

public static class Options.OptionsBuilder
extends AbstractBuilder<Options>

Constructor Summary

Constructors
Constructor and Description

OptionsBuilder()

Constructors
Constructor and Description
`OptionsBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Options.OptionsBuilder`	`activeButtonClass(java.lang.String activeButtonClass)` CSS class added to active buttons in the toolbar.
`Anchor.AnchorBuilder`	`anchor()` Step into anchor configuration.
`AnchorPreview.AnchorPreviewBuilder`	`anchorPreview()` Step into anchor preview configuration.
`Options.OptionsBuilder`	`anchorPreviewDisabled()` Disables the anchor preview.
`Options.OptionsBuilder`	`autoLink(boolean autoLink)` The auto-link handler is a built-in extension which automatically turns URLs entered into the text field into HTML anchor tags (similar to the functionality of Markdown).
`Options`	`build()` For internal use only.
`elemental.json.JsonValue`	`buildJson()` For internal use only.
`Options.OptionsBuilder`	`defaultButtonLabels()` Enables the default non font-awesome button labels.
`Options.OptionsBuilder`	`delay(int delay)` Time in milliseconds to show the toolbar or anchor tag preview.
`Options.OptionsBuilder`	`disableDoubleReturn(boolean disableDoubleReturn)` Allows/disallows two (or more) empty new lines.
`Options.OptionsBuilder`	`disableEditing(boolean disableEditing)` Enables/disables adding the contenteditable behavior.
`Options.OptionsBuilder`	`disableExtraSpaces(boolean disableExtraSpaces)` When set to true, it disallows spaces at the beginning and end of the element.
`Options.OptionsBuilder`	`disableReturn(boolean disableReturn)` Enables/disables the use of the return-key.
`Options.OptionsBuilder`	`done()`
`Options.OptionsBuilder`	`fontawesomeButtonLabels()` Fontawesome buttons are use by default and must not be activated.
`java.lang.String`	`getTranslation(java.lang.String code)`
`Options.OptionsBuilder`	`imageDragging(boolean imageDragging)` The image dragging handler is a built-in extension for handling dragging & dropping images into the contenteditable.
`KeyboardCommands.KeyboardCommandsBuilder`	`keyboadCommands()` Step into keyboard command configuration.
`Options.OptionsBuilder`	`keyboardCommandsDisabled()` Disables the keyboard commands.
`Options.OptionsBuilder`	`locale(java.util.Locale locale)`
`PasteHandler.PasteHandlerBuilder`	`paste()` Step into the paste option configuration
`Options.OptionsBuilder`	`pasteHandlingDisabled()` Disables the paste handling
`Placeholder.PlaceholderBuilder`	`placeholder()` Step into placeholder configuration.
`Options.OptionsBuilder`	`placeholderDisabled()` Disables the placeholders.
`Options.OptionsBuilder`	`spellcheck(boolean spellcheck)` Enable/disable native contentEditable automatic spellcheck.
`Options.OptionsBuilder`	`targetBlank(boolean targetBlank)` Enables/disables automatically adding the target="_blank" attribute to anchor tags.
`Toolbar.ToolbarBuilder`	`toolbar()` Step into toolbar configuration.
`Options.OptionsBuilder`	`toolbarDisabled()` Disables the toolbar.
`Options.OptionsBuilder`	`useDefaultLocaleFallback(boolean useDefaultLocaleFallback)` If true the ResourceBundle uses `Locale.getDefault()` as fallback locale, which might not English.

Methods inherited from class com.byteowls.vaadin.mediumeditor.options.AbstractBuilder
putNotNull, putNotNull, putNotNull, putNotNull, putNotNull, putNotNull

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OptionsBuilder
```
public OptionsBuilder()
```
- Method Detail
  - locale
```
public Options.OptionsBuilder locale(java.util.Locale locale)
```
  - useDefaultLocaleFallback
```
public Options.OptionsBuilder useDefaultLocaleFallback(boolean useDefaultLocaleFallback)
```
    If true the ResourceBundle uses Locale.getDefault() as fallback locale, which might not English. Normally using this is not needed.
    
    Parameters:
    
    useDefaultLocaleFallback - use the default-locale as fallback in the ResourceBundle
    
    Returns:
    
    the Options.OptionsBuilder for chaining.
  - getTranslation
```
public java.lang.String getTranslation(java.lang.String code)
```
  - activeButtonClass
```
public Options.OptionsBuilder activeButtonClass(java.lang.String activeButtonClass)
```
    CSS class added to active buttons in the toolbar. Default: 'medium-editor-button-active'
  - fontawesomeButtonLabels
```
public Options.OptionsBuilder fontawesomeButtonLabels()
```
    Fontawesome buttons are use by default and must not be activated.
  - defaultButtonLabels
```
public Options.OptionsBuilder defaultButtonLabels()
```
    Enables the default non font-awesome button labels.
  - delay
```
public Options.OptionsBuilder delay(int delay)
```
    Time in milliseconds to show the toolbar or anchor tag preview. Default: 0
  - disableReturn
```
public Options.OptionsBuilder disableReturn(boolean disableReturn)
```
    Enables/disables the use of the return-key. You can also set specific element behavior by using setting a data-disable-return attribute. Default: false
  - disableDoubleReturn
```
public Options.OptionsBuilder disableDoubleReturn(boolean disableDoubleReturn)
```
    Allows/disallows two (or more) empty new lines. You can also set specific element behavior by using setting a data-disable-double-return attribute. Default: false
  - disableExtraSpaces
```
public Options.OptionsBuilder disableExtraSpaces(boolean disableExtraSpaces)
```
    When set to true, it disallows spaces at the beginning and end of the element. Also it disallows entering 2 consecutive spaces between 2 words. Default: false
  - disableEditing
```
public Options.OptionsBuilder disableEditing(boolean disableEditing)
```
    Enables/disables adding the contenteditable behavior. Useful for using the toolbar with customized buttons/actions. You can also set specific element behavior by using setting a data-disable-editing attribute. Default: false
  - spellcheck
```
public Options.OptionsBuilder spellcheck(boolean spellcheck)
```
    Enable/disable native contentEditable automatic spellcheck. Default: true
  - targetBlank
```
public Options.OptionsBuilder targetBlank(boolean targetBlank)
```
    Enables/disables automatically adding the target="_blank" attribute to anchor tags. Default: false
  - autoLink
```
public Options.OptionsBuilder autoLink(boolean autoLink)
```
    The auto-link handler is a built-in extension which automatically turns URLs entered into the text field into HTML anchor tags (similar to the functionality of Markdown). Default: false
  - imageDragging
```
public Options.OptionsBuilder imageDragging(boolean imageDragging)
```
    The image dragging handler is a built-in extension for handling dragging & dropping images into the contenteditable. Default: true
  - toolbarDisabled
```
public Options.OptionsBuilder toolbarDisabled()
```
    Disables the toolbar.
  - toolbar
```
public Toolbar.ToolbarBuilder toolbar()
```
    Step into toolbar configuration.
  - anchorPreviewDisabled
```
public Options.OptionsBuilder anchorPreviewDisabled()
```
    Disables the anchor preview.
  - anchorPreview
```
public AnchorPreview.AnchorPreviewBuilder anchorPreview()
```
    Step into anchor preview configuration.
  - placeholderDisabled
```
public Options.OptionsBuilder placeholderDisabled()
```
    Disables the placeholders.
  - placeholder
```
public Placeholder.PlaceholderBuilder placeholder()
```
    Step into placeholder configuration.
  - anchor
```
public Anchor.AnchorBuilder anchor()
```
    Step into anchor configuration.
  - pasteHandlingDisabled
```
public Options.OptionsBuilder pasteHandlingDisabled()
```
    Disables the paste handling
  - paste
```
public PasteHandler.PasteHandlerBuilder paste()
```
    Step into the paste option configuration
  - keyboardCommandsDisabled
```
public Options.OptionsBuilder keyboardCommandsDisabled()
```
    Disables the keyboard commands.
  - keyboadCommands
```
public KeyboardCommands.KeyboardCommandsBuilder keyboadCommands()
```
    Step into keyboard command configuration.
  - done
```
public Options.OptionsBuilder done()
```
  - build
```
public Options build()
```
    Description copied from class: AbstractBuilder
    
    For internal use only.
    
    Specified by:
    
    build in class AbstractBuilder<Options>
  - buildJson
```
public elemental.json.JsonValue buildJson()
```
    Description copied from class: AbstractBuilder
    
    For internal use only.
    
    Specified by:
    
    buildJson in class AbstractBuilder<Options>

Class Options.OptionsBuilder

Constructor Summary

Method Summary

Methods inherited from class com.byteowls.vaadin.mediumeditor.options.AbstractBuilder

Methods inherited from class java.lang.Object

Constructor Detail

OptionsBuilder

Method Detail

locale

useDefaultLocaleFallback

getTranslation

activeButtonClass

fontawesomeButtonLabels

defaultButtonLabels

delay

disableReturn

disableDoubleReturn

disableExtraSpaces

disableEditing

spellcheck

targetBlank

autoLink

imageDragging

toolbarDisabled

toolbar

anchorPreviewDisabled

anchorPreview

placeholderDisabled

placeholder

anchor

pasteHandlingDisabled

paste

keyboardCommandsDisabled

keyboadCommands

done

build

buildJson