Toolbar.ToolbarBuilder (addon 2.0.0 API)

java.lang.Object
- com.byteowls.vaadin.mediumeditor.options.AbstractBuilder<Toolbar>
- - com.byteowls.vaadin.mediumeditor.options.Toolbar.ToolbarBuilder

Enclosing class:: Toolbar

public static class Toolbar.ToolbarBuilder
extends AbstractBuilder<Toolbar>

Constructor Summary

Constructors
Constructor and Description

ToolbarBuilder(Options.OptionsBuilder optionsBuilder)

Constructors
Constructor and Description
`ToolbarBuilder(Options.OptionsBuilder optionsBuilder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Toolbar.ToolbarBuilder`	`alignCenter()` When the static option is true, this aligns the static toolbar relative to the center of the medium-editor element.
`Toolbar.ToolbarBuilder`	`alignLeft()` When the static option is true, this aligns the static toolbar relative to the left of the medium-editor element.
`Toolbar.ToolbarBuilder`	`alignRight()` When the static option is true, this aligns the static toolbar relative to the right of the medium-editor element.
`Toolbar.ToolbarBuilder`	`allButtons()` Enable all buttons.
`Toolbar.ToolbarBuilder`	`allowMultiParagraphSelection(boolean allowMultiParagraphSelection)` Enables/disables whether the toolbar should be displayed when selecting multiple paragraphs/block elements.
`Toolbar`	`build()` For internal use only.
`elemental.json.JsonValue`	`buildJson()` For internal use only.
`Toolbar.ToolbarBuilder`	`button(Buttons button)` Add a build in button
`Toolbar.ToolbarBuilder`	`button(Buttons button, java.lang.String tooltip)` Add a button with a tooltip
`Toolbar.ToolbarBuilder`	`buttonAfter(Buttons after, Buttons incoming)` Add a button after another one.
`Toolbar.ToolbarBuilder`	`buttonBefore(Buttons before, Buttons incoming)` Add a button before another one.
`Toolbar.ToolbarBuilder`	`buttons(Buttons... buttons)` Add buttons
`Toolbar.ToolbarBuilder`	`buttons(ToolbarButton.ToolbarButtonBuilder... toolbarButtonBuilders)` Add buttons as `ToolbarButton.ToolbarButtonBuilder`
`Toolbar.ToolbarBuilder`	`buttonTranslations(java.lang.String... translations)` Set the translations to the existing buttons.
`Toolbar.ToolbarBuilder`	`clearButtons()` Clear the configured buttons.
`Toolbar.ToolbarBuilder`	`defaultButtons()` Enable the default buttons, which are ['bold', 'italic', 'underline', 'anchor', 'h2', 'h3', 'quote']
`Toolbar.ToolbarBuilder`	`diffLeft(int diffLeft)` Value in pixels to be added to the X axis positioning of the toolbar.
`Toolbar.ToolbarBuilder`	`diffTop(int diffTop)` Value in pixels to be added to the Y axis positioning of the toolbar.
`Options.OptionsBuilder`	`done()`
`Toolbar.ToolbarBuilder`	`firstButtonClass(java.lang.String firstButtonClass)` CSS class added to the first button in the toolbar.
`Toolbar.ToolbarBuilder`	`lastButtonClass(java.lang.String lastButtonClass)` CSS class added to the last button in the toolbar.
`Toolbar.ToolbarBuilder`	`standardizeSelectionStart(boolean standardizeSelectionStart)` Enables/disables standardizing how the beginning of a range is decided between browsers whenever the selected text is analyzed for updating toolbar buttons status.
`Toolbar.ToolbarBuilder`	`staticToolbar(boolean staticToolbar)` Enable/disable the toolbar always displaying in the same location relative to the medium-editor element.
`Toolbar.ToolbarBuilder`	`sticky(boolean sticky)` When the static option is true, this enables/disables the toolbar "sticking" to the viewport and staying visible on the screen while the page scrolls.
`Toolbar.ToolbarBuilder`	`stickyTopOffset(boolean stickyTopOffset)` When the sticky option is true, this set in pixel a top offset above the toolbar.
`Toolbar.ToolbarBuilder`	`updateOnEmptySelection(boolean updateOnEmptySelection)` When the static option is true, this enables/disables updating the state of the toolbar buttons even when the selection is collapsed (there is no selection, just a cursor).

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
  - ToolbarBuilder
```
public ToolbarBuilder(Options.OptionsBuilder optionsBuilder)
```
- Method Detail
  - allowMultiParagraphSelection
```
public Toolbar.ToolbarBuilder allowMultiParagraphSelection(boolean allowMultiParagraphSelection)
```
    Enables/disables whether the toolbar should be displayed when selecting multiple paragraphs/block elements. Default: true
  - defaultButtons
```
public Toolbar.ToolbarBuilder defaultButtons()
```
    Enable the default buttons, which are ['bold', 'italic', 'underline', 'anchor', 'h2', 'h3', 'quote']
  - allButtons
```
public Toolbar.ToolbarBuilder allButtons()
```
    Enable all buttons.
  - buttonTranslations
```
public Toolbar.ToolbarBuilder buttonTranslations(java.lang.String... translations)
```
    Set the translations to the existing buttons. The order is important.
    
    Parameters:
    
    translations - the already added button's translations
    
    Returns:
    
    the Toolbar.ToolbarBuilder for chaining
  - button
```
public Toolbar.ToolbarBuilder button(Buttons button)
```
    Add a build in button
  - button
```
public Toolbar.ToolbarBuilder button(Buttons button,
                                     java.lang.String tooltip)
```
    Add a button with a tooltip
  - buttons
```
public Toolbar.ToolbarBuilder buttons(Buttons... buttons)
```
    Add buttons
  - buttons
```
public Toolbar.ToolbarBuilder buttons(ToolbarButton.ToolbarButtonBuilder... toolbarButtonBuilders)
```
    Add buttons as ToolbarButton.ToolbarButtonBuilder
  - buttonBefore
```
public Toolbar.ToolbarBuilder buttonBefore(Buttons before,
                                           Buttons incoming)
```
    Add a button before another one.
  - buttonAfter
```
public Toolbar.ToolbarBuilder buttonAfter(Buttons after,
                                          Buttons incoming)
```
    Add a button after another one.
  - clearButtons
```
public Toolbar.ToolbarBuilder clearButtons()
```
    Clear the configured buttons.
  - diffLeft
```
public Toolbar.ToolbarBuilder diffLeft(int diffLeft)
```
    Value in pixels to be added to the X axis positioning of the toolbar. Default: 0
  - diffTop
```
public Toolbar.ToolbarBuilder diffTop(int diffTop)
```
    Value in pixels to be added to the Y axis positioning of the toolbar. Default: -10
  - firstButtonClass
```
public Toolbar.ToolbarBuilder firstButtonClass(java.lang.String firstButtonClass)
```
    CSS class added to the first button in the toolbar. Default: 'medium-editor-button-first'
  - lastButtonClass
```
public Toolbar.ToolbarBuilder lastButtonClass(java.lang.String lastButtonClass)
```
    CSS class added to the last button in the toolbar. Default: 'medium-editor-button-last'
  - standardizeSelectionStart
```
public Toolbar.ToolbarBuilder standardizeSelectionStart(boolean standardizeSelectionStart)
```
    Enables/disables standardizing how the beginning of a range is decided between browsers whenever the selected text is analyzed for updating toolbar buttons status. Default: false
  - staticToolbar
```
public Toolbar.ToolbarBuilder staticToolbar(boolean staticToolbar)
```
    Enable/disable the toolbar always displaying in the same location relative to the medium-editor element. Default: false
  - alignLeft
```
public Toolbar.ToolbarBuilder alignLeft()
```
    When the static option is true, this aligns the static toolbar relative to the left of the medium-editor element.
  - alignCenter
```
public Toolbar.ToolbarBuilder alignCenter()
```
    When the static option is true, this aligns the static toolbar relative to the center of the medium-editor element.
  - alignRight
```
public Toolbar.ToolbarBuilder alignRight()
```
    When the static option is true, this aligns the static toolbar relative to the right of the medium-editor element.
  - sticky
```
public Toolbar.ToolbarBuilder sticky(boolean sticky)
```
    When the static option is true, this enables/disables the toolbar "sticking" to the viewport and staying visible on the screen while the page scrolls. Default: false
  - stickyTopOffset
```
public Toolbar.ToolbarBuilder stickyTopOffset(boolean stickyTopOffset)
```
    When the sticky option is true, this set in pixel a top offset above the toolbar. Default: 0
  - updateOnEmptySelection
```
public Toolbar.ToolbarBuilder updateOnEmptySelection(boolean updateOnEmptySelection)
```
    When the static option is true, this enables/disables updating the state of the toolbar buttons even when the selection is collapsed (there is no selection, just a cursor). Default: false
  - done
```
public Options.OptionsBuilder done()
```
  - build
```
public Toolbar build()
```
    Description copied from class: AbstractBuilder
    
    For internal use only.
    
    Specified by:
    
    build in class AbstractBuilder<Toolbar>
  - buildJson
```
public elemental.json.JsonValue buildJson()
```
    Description copied from class: AbstractBuilder
    
    For internal use only.
    
    Specified by:
    
    buildJson in class AbstractBuilder<Toolbar>

Class Toolbar.ToolbarBuilder

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ToolbarBuilder

Method Detail

allowMultiParagraphSelection

defaultButtons

allButtons

buttonTranslations

button

button

buttons

buttons

buttonBefore

buttonAfter

clearButtons

diffLeft

diffTop

firstButtonClass

lastButtonClass

standardizeSelectionStart

staticToolbar

alignLeft

alignCenter

alignRight

sticky

stickyTopOffset

updateOnEmptySelection

done

build

buildJson