SummernoteBase (GwtBootstrap3 Extras 0.9.4 API)

Object
- UIObject
- - Widget
  - - Panel
    - - ComplexPanel
      - ComplexWidget
        
        Div
        
        SummernoteBase

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, Iterable<Widget>, HasId, HasInlineStyle, HasPull, HasResponsiveness, HasAllSummernoteHandlers, HasSummernoteBlurHandlers, HasSummernoteChangeHandlers, HasSummernoteEnterHandlers, HasSummernoteFocusHandlers, HasSummernoteImageUploadHandlers, HasSummernoteInitHandlers, HasSummernoteKeyDownHandlers, HasSummernoteKeyUpHandlers, HasSummernotePasteHandlers

Direct Known Subclasses:

Summernote
```
public class SummernoteBase
extends Div
implements HasAllSummernoteHandlers, HasEnabled
```
Wrapper for the Summernote WYSIWYG Editor
See: http://summernote.org/

Author:

Xiaodong Sun

Nested Class Summary
- Nested classes/interfaces inherited from class UIObject
  UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
- Nested classes/interfaces inherited from interface IndexedPanel
  IndexedPanel.ForIsWidget
- Nested classes/interfaces inherited from interface HasWidgets
  HasWidgets.ForIsWidget

Field Summary
- Fields inherited from class UIObject
  DEBUG_ID_PREFIX
- Fields inherited from interface HasAllSummernoteHandlers
  SUMMERNOTE_BLUR_EVENT, SUMMERNOTE_CHANGE_EVENT, SUMMERNOTE_ENTER_EVENT, SUMMERNOTE_FOCUS_EVENT, SUMMERNOTE_IMAGE_UPLOAD_EVENT, SUMMERNOTE_INIT_EVENT, SUMMERNOTE_KEYDOWN_EVENT, SUMMERNOTE_KEYUP_EVENT, SUMMERNOTE_PASTE_EVENT, SUMMERNOTE_PREFIX

Constructor Summary

Constructors
Constructor and Description

SummernoteBase()

Constructors
Constructor and Description
`SummernoteBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addSummernoteBlurHandler(SummernoteBlurHandler handler)` Adds a `SummernoteBlurEvent` handler.
`HandlerRegistration`	`addSummernoteChangeHandler(SummernoteChangeHandler handler)` Adds a `SummernoteChangeEvent` handler.
`HandlerRegistration`	`addSummernoteEnterHandler(SummernoteEnterHandler handler)` Adds a `SummernoteEnterEvent` handler.
`HandlerRegistration`	`addSummernoteFocusHandler(SummernoteFocusHandler handler)` Adds a `SummernoteFocusEvent` handler.
`HandlerRegistration`	`addSummernoteImageUploadHandler(SummernoteImageUploadHandler handler)` Adds a `SummernoteImageUploadEvent` handler.
`HandlerRegistration`	`addSummernoteInitHandler(SummernoteInitHandler handler)` Adds a `SummernoteInitEvent` handler.
`HandlerRegistration`	`addSummernoteKeyDownHandler(SummernoteKeyDownHandler handler)` Adds a `SummernoteKeyDownEvent` handler.
`HandlerRegistration`	`addSummernoteKeyUpHandler(SummernoteKeyUpHandler handler)` Adds a `SummernoteKeyUpEvent` handler.
`HandlerRegistration`	`addSummernotePasteHandler(SummernotePasteHandler handler)` Adds a `SummernotePasteEvent` handler.
`void`	`clear()` Removes all contents and restores the editable instance to an `_emptyPara_`: <p><br></p>
`String`	`getCode()` Gets the HTML code generated from the editor
`SummernoteLanguage`	`getLanguage()` Returns the editor language.
`void`	`insertImages(JsArray<SummernoteImageUploadEvent.ImageFile> images)` Inserts the given images to the editor. This method should be used only when you customize the image upload handler.
`boolean`	`isEmpty()` Returns `true` if the content is empty. Editing area needs `<p><br></p>` for focus, even if contents is empty.
`boolean`	`isEnabled()`
`protected void`	`onLoad()`
`protected void`	`onUnload()`
`void`	`reconfigure()` Call this when updating options to ensure everything is up to date
`void`	`reset()` Clear editor contents and remove all stored history.
`void`	`setAirMode(boolean airMode)` Set the air mode of the editor.
`void`	`setCode(String code)` Sets the given HTML code to the editor.
`void`	`setDefaultHeight(int height)` Sets the default height of the editor (in pixel). Note: DO NOT renamed this method to setHeight to avoid UiBinder name clash with `UIObject.setHeight(String)`.
`void`	`setDialogsFade(boolean dialogsFade)` Set `true` to turn on dialogs fading effect when showing or hiding. Defaults to `false`.
`void`	`setDialogsInBody(boolean dialogsInBody)` Set `true` to place dialogs in <body> rather than in the editor. Defaults to `false`.
`void`	`setDisableDragAndDrop(boolean disableDragAndDrop)` Set `true` to disable drag and drop. Defaults to `false`.
`void`	`setEnabled(boolean enabled)`
`void`	`setFontNames(SummernoteFontName... fontNames)` Set customized font names.
`void`	`setFontNamesIgnoreCheck(SummernoteFontName... fontNames)` Set a list for Web fonts to be ignored.
`void`	`setHasFocus(boolean focus)` Set the focus of the editor.
`void`	`setHint(String matchRegexp, HintHandler hintHandler)` Summernote support hint (autocomplete) feature.
`void`	`setLanguage(SummernoteLanguage language)` Set the editor language.
`void`	`setMaxHeight(int maxHeight)` Sets the maximum height of the editor (in pixel).
`void`	`setMinHeight(int minHeight)` Sets the minimum height of the editor (in pixel).
`void`	`setPlaceholder(String placeholder)` Set placeholder of the editor.
`void`	`setShortcuts(boolean shortcuts)` Set `false` to disable custom shortcuts. Defaults to `true`.
`void`	`setShowToolbar(boolean showToolbar)` If `false` the toolbar will be hidden. Defaults to `true`.
`void`	`setToolbar(Toolbar toolbar)` Customizes the toolbar. Example:

Methods inherited from class ComplexWidget
add, getId, getPull, insert, insert, remove, setColor, setHiddenOn, setId, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPull, setVisibleOn

Methods inherited from class ComplexPanel
add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, remove

Methods inherited from class Panel
add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface HasHandlers
fireEvent

Methods inherited from interface Iterable
forEach, spliterator

- Constructor Detail
 - SummernoteBase
```
public SummernoteBase()
```
- Method Detail
 - setDefaultHeight
```
public void setDefaultHeight(int height)
```
 Sets the default height of the editor (in pixel).
 
 Note: DO NOT renamed this method to setHeight to avoid UiBinder name clash with UIObject.setHeight(String).
 
 Parameters:
 
 height -
 - setMaxHeight
```
public void setMaxHeight(int maxHeight)
```
 Sets the maximum height of the editor (in pixel).
 
 Parameters:
 
 maxHeight -
 - setMinHeight
```
public void setMinHeight(int minHeight)
```
 Sets the minimum height of the editor (in pixel).
 
 Parameters:
 
 minHeight -
 - setShowToolbar
```
public void setShowToolbar(boolean showToolbar)
```
 If false the toolbar will be hidden.
 
 Defaults to true.
 
 Parameters:
 
 showToolbar -
 - setToolbar
```
public void setToolbar(Toolbar toolbar)
```
 Customizes the toolbar.
 
 Example:
```
 summernote.setToolbar(new Toolbar()
 .addGroup(ToolbarButton.OL, ToolbarButton.BOLD)
 .addGroup(ToolbarButton.HELP));
 
```
 Parameters:
 
 toolbar -
 - setHasFocus
```
public void setHasFocus(boolean focus)
```
 Set the focus of the editor.
 
 Parameters:
 
 focus - if true, focus on the editor
 - setPlaceholder
```
public void setPlaceholder(String placeholder)
```
 Set placeholder of the editor.
 
 Parameters:
 
 placeholder - placeholder of the editor
 - setFontNames
```
public void setFontNames(SummernoteFontName... fontNames)
```
 Set customized font names.
 
 Parameters:
 
 fontNames - customized font names
 
 See Also:
 
 SummernoteFontName
 - setFontNamesIgnoreCheck
```
public void setFontNamesIgnoreCheck(SummernoteFontName... fontNames)
```
 Set a list for Web fonts to be ignored.
 
 Summernote tests font in fontNames before adding them to drop-down. This is problem while using Web fonts. It’s not easy picking up nice time to check availabilities of Web fonts.
 
 Parameters:
 
 fontNames -
 - setAirMode
```
public void setAirMode(boolean airMode)
```
 Set the air mode of the editor. Air-mode gives clearer interface with hidden toolbar. To reveal toolbar, select a text where you want to shape up.
 
 Defaults to false.
 
 Parameters:
 
 airMode - if true, the air mode is turn on
 - setShortcuts
```
public void setShortcuts(boolean shortcuts)
```
 Set false to disable custom shortcuts.
 
 Defaults to true.
 
 Parameters:
 
 shortcuts - if false, disable custom shortcuts
 - setDialogsInBody
```
public void setDialogsInBody(boolean dialogsInBody)
```
 Set true to place dialogs in <body> rather than in the editor.
 
 Defaults to false.
 
 Parameters:
 
 dialogsInBody - if true, place dialogs in <body>
 - setDialogsFade
```
public void setDialogsFade(boolean dialogsFade)
```
 Set true to turn on dialogs fading effect when showing or hiding.
 
 Defaults to false.
 
 Parameters:
 
 dialogsFade - if true, turn on dialogs fading effect
 - setDisableDragAndDrop
```
public void setDisableDragAndDrop(boolean disableDragAndDrop)
```
 Set true to disable drag and drop.
 
 Defaults to false.
 
 Parameters:
 
 disableDragAndDrop - if true, disable drag and drop
 - setHint
```
public void setHint(String matchRegexp,
 HintHandler hintHandler)
```
 Summernote support hint (autocomplete) feature. You can define custom hint with options.
 
 Parameters:
 
 matchRegexp -
 
 hintHandler -
 - setLanguage
```
public void setLanguage(SummernoteLanguage language)
```
 Set the editor language.
 
 Parameters:
 
 language - supported editor language
 - getLanguage
```
public SummernoteLanguage getLanguage()
```
 Returns the editor language.
 
 Returns:
 - addSummernoteInitHandler
```
public HandlerRegistration addSummernoteInitHandler(SummernoteInitHandler handler)
```
 Description copied from interface: HasSummernoteInitHandlers
 
 Adds a SummernoteInitEvent handler.
 
 Specified by:
 
 addSummernoteInitHandler in interface HasSummernoteInitHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernoteEnterHandler
```
public HandlerRegistration addSummernoteEnterHandler(SummernoteEnterHandler handler)
```
 Description copied from interface: HasSummernoteEnterHandlers
 
 Adds a SummernoteEnterEvent handler.
 
 Specified by:
 
 addSummernoteEnterHandler in interface HasSummernoteEnterHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernoteFocusHandler
```
public HandlerRegistration addSummernoteFocusHandler(SummernoteFocusHandler handler)
```
 Description copied from interface: HasSummernoteFocusHandlers
 
 Adds a SummernoteFocusEvent handler.
 
 Specified by:
 
 addSummernoteFocusHandler in interface HasSummernoteFocusHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernoteBlurHandler
```
public HandlerRegistration addSummernoteBlurHandler(SummernoteBlurHandler handler)
```
 Description copied from interface: HasSummernoteBlurHandlers
 
 Adds a SummernoteBlurEvent handler.
 
 Specified by:
 
 addSummernoteBlurHandler in interface HasSummernoteBlurHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernoteKeyUpHandler
```
public HandlerRegistration addSummernoteKeyUpHandler(SummernoteKeyUpHandler handler)
```
 Description copied from interface: HasSummernoteKeyUpHandlers
 
 Adds a SummernoteKeyUpEvent handler.
 
 Specified by:
 
 addSummernoteKeyUpHandler in interface HasSummernoteKeyUpHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernoteKeyDownHandler
```
public HandlerRegistration addSummernoteKeyDownHandler(SummernoteKeyDownHandler handler)
```
 Description copied from interface: HasSummernoteKeyDownHandlers
 
 Adds a SummernoteKeyDownEvent handler.
 
 Specified by:
 
 addSummernoteKeyDownHandler in interface HasSummernoteKeyDownHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernotePasteHandler
```
public HandlerRegistration addSummernotePasteHandler(SummernotePasteHandler handler)
```
 Description copied from interface: HasSummernotePasteHandlers
 
 Adds a SummernotePasteEvent handler.
 
 Specified by:
 
 addSummernotePasteHandler in interface HasSummernotePasteHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernoteImageUploadHandler
```
public HandlerRegistration addSummernoteImageUploadHandler(SummernoteImageUploadHandler handler)
```
 Description copied from interface: HasSummernoteImageUploadHandlers
 
 Adds a SummernoteImageUploadEvent handler.
 
 Specified by:
 
 addSummernoteImageUploadHandler in interface HasSummernoteImageUploadHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - addSummernoteChangeHandler
```
public HandlerRegistration addSummernoteChangeHandler(SummernoteChangeHandler handler)
```
 Description copied from interface: HasSummernoteChangeHandlers
 
 Adds a SummernoteChangeEvent handler.
 
 Specified by:
 
 addSummernoteChangeHandler in interface HasSummernoteChangeHandlers
 
 Parameters:
 
 handler - the handler
 
 Returns:
 
 the registration for the event
 - getCode
```
public String getCode()
```
 Gets the HTML code generated from the editor
 
 Returns:
 
 generated code
 - setCode
```
public void setCode(String code)
```
 Sets the given HTML code to the editor.
 
 Parameters:
 
 code -
 - isEmpty
```
public boolean isEmpty()
```
 Returns true if the content is empty.
 
 Editing area needs   for focus, even if contents is empty. So summernote supports this method for helping to check contents is empty.
 
 Returns:
 
 true if the editor is empty
 - clear
```
public void clear()
```
 Removes all contents and restores the editable instance to an _emptyPara_: 
 
 Specified by:
 
 clear in interface HasWidgets
 
 Overrides:
 
 clear in class Panel
 - setEnabled
```
public void setEnabled(boolean enabled)
```
 Specified by:
 
 setEnabled in interface HasEnabled
 - isEnabled
```
public boolean isEnabled()
```
 Specified by:
 
 isEnabled in interface HasEnabled
 - reset
```
public void reset()
```
 Clear editor contents and remove all stored history.
 - reconfigure
```
public void reconfigure()
```
 Call this when updating options to ensure everything is up to date
 - onLoad
```
protected void onLoad()
```
 Overrides:
 
 onLoad in class Widget
 - onUnload
```
protected void onUnload()
```
 Overrides:
 
 onUnload in class Widget
 - insertImages
```
public void insertImages(JsArray<SummernoteImageUploadEvent.ImageFile> images)
```
 Inserts the given images to the editor.
 
 This method should be used only when you customize the image upload handler.
 
 Parameters:
 
 images -

Class SummernoteBase

Nested Class Summary

Nested classes/interfaces inherited from class UIObject

Nested classes/interfaces inherited from interface IndexedPanel

Nested classes/interfaces inherited from interface HasWidgets

Field Summary

Fields inherited from class UIObject

Fields inherited from interface HasAllSummernoteHandlers

Constructor Summary

Method Summary

Methods inherited from class ComplexWidget

Methods inherited from class ComplexPanel

Methods inherited from class Panel

Methods inherited from class Widget

Methods inherited from class UIObject

Methods inherited from class Object

Methods inherited from interface HasHandlers

Methods inherited from interface Iterable

Constructor Detail

SummernoteBase

Method Detail

setDefaultHeight

setMaxHeight

setMinHeight

setShowToolbar

setToolbar

setHasFocus

setPlaceholder

setFontNames

setFontNamesIgnoreCheck

setAirMode

setShortcuts

setDialogsInBody

setDialogsFade

setDisableDragAndDrop

setHint

setLanguage

getLanguage

addSummernoteInitHandler

addSummernoteEnterHandler

addSummernoteFocusHandler

addSummernoteBlurHandler

addSummernoteKeyUpHandler

addSummernoteKeyDownHandler

addSummernotePasteHandler

addSummernoteImageUploadHandler

addSummernoteChangeHandler

getCode

setCode

isEmpty

clear

setEnabled

isEnabled

reset

reconfigure

onLoad

onUnload

insertImages