org.vaadin.alump.ckeditor.client

Class VCKEditorTextField

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

org.vaadin.alump.ckeditor.client.VCKEditorTextField

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.vaadin.client.Paintable, org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

Direct Known Subclasses:

VMagnoliaCKEditorTextField

public class VCKEditorTextField
extends com.google.gwt.user.client.ui.Widget
implements com.vaadin.client.Paintable, org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener, com.google.gwt.user.client.ui.Focusable

Client side CKEditor widget which communicates with the server. Messages from the server are shown as HTML and mouse clicks are sent to the server.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_FOCUS
static String	ATTR_IMMEDIATE
static String	ATTR_INPAGECONFIG
static String	ATTR_INSERT_HTML
static String	ATTR_INSERT_TEXT
static String	ATTR_KEYSTROKES_COMMAND
static String	ATTR_KEYSTROKES_KEYSTROKE
static String	ATTR_PROTECTED_BODY
static String	ATTR_PROTECTED_SOURCE
static String	ATTR_READONLY
static String	ATTR_VIEW_WITHOUT_EDITOR
static String	ATTR_WRITER_INDENTATIONCHARS
static String	ATTR_WRITERRULES_JSRULE
static String	ATTR_WRITERRULES_TAGNAME
static String	CLASSNAME Set the CSS class name to allow styling.
protected com.vaadin.client.ApplicationConnection	clientToServer Reference to the server connection object.
static String	EVENT_SELECTION_CHANGE
protected String	paintableId The client side widget identifier
static String	VAR_TEXT
static String	VAR_VAADIN_SAVE_BUTTON_PRESSED
static String	VAR_VERSION

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
VCKEditorTextField() The constructor should first call super() to initialize the component and then handle any initialization relevant to Vaadin.

Method Summary

Modifier and Type	Method and Description
protected void	doResize()
int	getTabIndex()
protected org.vaadin.alump.ckeditor.client.CKEditor	loadEditor(String inPageConfig) Expose loadEditor command to subclasses, so that they can perform additional logic before/after creating CKEditor instance on the page, e.g.
void	onBlur()
void	onChange()
void	onDataReady()
void	onFocus()
void	onInstanceReady()
void	onModeChange(String mode)
void	onSave()
void	onSelectionChange()
protected void	onUnload()
void	setAccessKey(char arg0)
void	setFocus(boolean arg0)
void	setHeight(String height)
void	setTabIndex(int tabIndex)
void	setWidth(String width)
void	updateFromUIDL(com.vaadin.client.UIDL uidl, com.vaadin.client.ApplicationConnection client) Called whenever an update is received from the server

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final String CLASSNAME

Set the CSS class name to allow styling.

See Also:

Constant Field Values

ATTR_FOCUS

public static final String ATTR_FOCUS

See Also:

Constant Field Values

ATTR_IMMEDIATE

public static final String ATTR_IMMEDIATE

See Also:

Constant Field Values

ATTR_READONLY

public static final String ATTR_READONLY

See Also:

Constant Field Values

ATTR_VIEW_WITHOUT_EDITOR

public static final String ATTR_VIEW_WITHOUT_EDITOR

See Also:

Constant Field Values

ATTR_INPAGECONFIG

public static final String ATTR_INPAGECONFIG

See Also:

Constant Field Values

ATTR_PROTECTED_SOURCE

public static final String ATTR_PROTECTED_SOURCE

See Also:

Constant Field Values

ATTR_WRITERRULES_TAGNAME

public static final String ATTR_WRITERRULES_TAGNAME

See Also:

Constant Field Values

ATTR_WRITERRULES_JSRULE

public static final String ATTR_WRITERRULES_JSRULE

See Also:

Constant Field Values

ATTR_WRITER_INDENTATIONCHARS

public static final String ATTR_WRITER_INDENTATIONCHARS

See Also:

Constant Field Values

ATTR_KEYSTROKES_KEYSTROKE

public static final String ATTR_KEYSTROKES_KEYSTROKE

See Also:

Constant Field Values

ATTR_KEYSTROKES_COMMAND

public static final String ATTR_KEYSTROKES_COMMAND

See Also:

Constant Field Values

ATTR_INSERT_HTML

public static final String ATTR_INSERT_HTML

See Also:

Constant Field Values

ATTR_INSERT_TEXT

public static final String ATTR_INSERT_TEXT

See Also:

Constant Field Values

ATTR_PROTECTED_BODY

public static final String ATTR_PROTECTED_BODY

See Also:

Constant Field Values

VAR_TEXT

public static final String VAR_TEXT

See Also:

Constant Field Values

VAR_VAADIN_SAVE_BUTTON_PRESSED

public static final String VAR_VAADIN_SAVE_BUTTON_PRESSED

See Also:

Constant Field Values

VAR_VERSION

public static final String VAR_VERSION

See Also:

Constant Field Values

EVENT_SELECTION_CHANGE

public static final String EVENT_SELECTION_CHANGE

See Also:

Constant Field Values

paintableId

protected String paintableId

The client side widget identifier

clientToServer

protected com.vaadin.client.ApplicationConnection clientToServer

Reference to the server connection object.

Constructor Detail

VCKEditorTextField

public VCKEditorTextField()

The constructor should first call super() to initialize the component and then handle any initialization relevant to Vaadin.

Method Detail

updateFromUIDL

public void updateFromUIDL(com.vaadin.client.UIDL uidl,
                           com.vaadin.client.ApplicationConnection client)

Called whenever an update is received from the server

Specified by:

updateFromUIDL in interface com.vaadin.client.Paintable

onSave

public void onSave()

Specified by:

onSave in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

onBlur

public void onBlur()

Specified by:

onBlur in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

onFocus

public void onFocus()

Specified by:

onFocus in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

onInstanceReady

public void onInstanceReady()

Specified by:

onInstanceReady in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

onChange

public void onChange()

Specified by:

onChange in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

onModeChange

public void onModeChange(String mode)

Specified by:

onModeChange in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

onSelectionChange

public void onSelectionChange()

Specified by:

onSelectionChange in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

onDataReady

public void onDataReady()

Specified by:

onDataReady in interface org.vaadin.alump.ckeditor.client.CKEditorService.CKEditorListener

setWidth

public void setWidth(String width)

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

setHeight

public void setHeight(String height)

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

doResize

protected void doResize()

onUnload

protected void onUnload()

Overrides:

onUnload in class com.google.gwt.user.client.ui.Widget

getTabIndex

public int getTabIndex()

Specified by:

getTabIndex in interface com.google.gwt.user.client.ui.Focusable

setTabIndex

public void setTabIndex(int tabIndex)

Specified by:

setTabIndex in interface com.google.gwt.user.client.ui.Focusable

setAccessKey

public void setAccessKey(char arg0)

Specified by:

setAccessKey in interface com.google.gwt.user.client.ui.Focusable

setFocus

public void setFocus(boolean arg0)

Specified by:

setFocus in interface com.google.gwt.user.client.ui.Focusable

loadEditor

protected org.vaadin.alump.ckeditor.client.CKEditor loadEditor(String inPageConfig)

Expose loadEditor command to subclasses, so that they can perform additional logic before/after creating CKEditor instance on the page, e.g. register external plugins.

This method is executed as a callback scheduled command when loading the CKEditor library has completed.