com.byteowls.vaadin.mediumeditor

Class MediumEditor

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractJavaScriptComponent

com.byteowls.vaadin.mediumeditor.MediumEditor

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, java.io.Serializable

@StyleSheet(value={"vaadin://mediumeditor/css/medium-editor.min.css","vaadin://mediumeditor/css/addon.min.css"})
 @JavaScript(value={"vaadin://mediumeditor/js/medium-editor.min.js","vaadin://mediumeditor/js/medium-editor-connector.js"})
public class MediumEditor
extends com.vaadin.ui.AbstractJavaScriptComponent

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediumEditor.BlurListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
MediumEditor()

Method Summary

Modifier and Type	Method and Description
void	addBlurListener(MediumEditor.BlurListener listener) Add a listener to handle the changed value from the editor.
void	configure(Options.OptionsBuilder builder) Configure the MediumEditor.
protected MediumEditorState	getState()
boolean	isFocusOutlineEnabled() If true the focus outline border is enabled else disabled.
boolean	isJsLoggingEnabled()
boolean	isReadOnly()
Options.OptionsBuilder	options() Returns the starting point for configuring the editor's options.
void	setContent(java.lang.String content) Set the content of editor
void	setFocusOutlineEnabled(boolean focusOutlineEnabled) Enables or disables the border around the component when it gets the focus.
void	setJsLoggingEnabled(boolean jsLoggingEnabled) Enable or disables the connector's logging to "console.log"
void	setReadOnly(boolean readOnly) Enable or disables the inline editing.
void	setTheme(MediumEditorTheme theme) Sets the theme of the medium editor.

Methods inherited from class com.vaadin.ui.AbstractJavaScriptComponent

addFunction, callFunction, getState, registerRpc

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

getUI

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

MediumEditor

public MediumEditor()

Method Detail

configure

public void configure(Options.OptionsBuilder builder)

Configure the MediumEditor.

Parameters:

builder - the option builder. Start by using options().

options

public Options.OptionsBuilder options()

Returns the starting point for configuring the editor's options.

Returns:

the builder for configuring the editor's options

setContent

public void setContent(java.lang.String content)

Set the content of editor

Parameters:

content - the editor content / value.

addBlurListener

public void addBlurListener(MediumEditor.BlurListener listener)

Add a listener to handle the changed value from the editor.

Parameters:

listener - a simple blurlistener retrieving just the value

isJsLoggingEnabled

public boolean isJsLoggingEnabled()

Returns:

True if the connector's logs defined messages to "console.log" else logging is disabled.

setJsLoggingEnabled

public void setJsLoggingEnabled(boolean jsLoggingEnabled)

Enable or disables the connector's logging to "console.log"

Parameters:

jsLoggingEnabled - If true the connector script will log defined messages to "console.log". Defaults to false.

setReadOnly

public void setReadOnly(boolean readOnly)

Enable or disables the inline editing. If readOnly is toggled on a initialised editor the editor's content will be reset to the server side content.

Overrides:

setReadOnly in class com.vaadin.ui.AbstractComponent

Parameters:

readOnly - If true no editing is possible. Defaults to false.

isReadOnly

public boolean isReadOnly()

Overrides:

isReadOnly in class com.vaadin.ui.AbstractComponent

setFocusOutlineEnabled

public void setFocusOutlineEnabled(boolean focusOutlineEnabled)

Enables or disables the border around the component when it gets the focus.

Parameters:

focusOutlineEnabled - True if a border around the component should be shown as soon as it gets the focus. If you don't like the border set it to false. Defaults to true.

isFocusOutlineEnabled

public boolean isFocusOutlineEnabled()

If true the focus outline border is enabled else disabled.

Returns:

True if the focus outline border is enabled else false.

setTheme

public void setTheme(MediumEditorTheme theme)

Sets the theme of the medium editor. The theme is global and is therefore assigned to all editors in the view.

Parameters:

theme - the medium editor theme.

getState

protected MediumEditorState getState()

Overrides:

getState in class com.vaadin.ui.AbstractJavaScriptComponent