com.vaadin.client.ui
Class VRichTextArea

java.lang.Object
  Composite
      com.vaadin.client.ui.VRichTextArea

All Implemented Interfaces:

Field

public class VRichTextArea
extends Composite
implements Field

This class implements a basic client side rich text editor component.

Author:

Vaadin Ltd.

Field Summary

static java.lang.String	CLASSNAME The input node CSS classname.
ApplicationConnection	client For internal use only.
VRichTextToolbar	formatter For internal use only.
HTML	html For internal use only.
java.lang.String	id For internal use only.
boolean	immediate For internal use only.
com.google.gwt.event.shared.HandlerRegistration	keyPressHandler For internal use only.
int	maxLength For internal use only.
RichTextArea	rta For internal use only.

Constructor Summary

VRichTextArea()

Method Summary

void	addBlurHandler(BlurHandler blurHandler) Adds a blur handler to the component.
java.lang.String	getSanitizedValue() Browsers differ in what they return as the content of a visually empty rich text area.
int	getTabIndex()
java.lang.String	getValue() Get the value the text area
void	onKeyDown(KeyDownEvent event)
void	onKeyPress(KeyPressEvent event)
void	removeBlurHandler(BlurHandler blurHandler) Removes a blur handler.
void	selectAll() For internal use only.
void	setAccessKey(char key)
void	setEnabled(boolean enabled)
void	setFocus(boolean focused)
void	setHeight(java.lang.String height)
void	setReadOnly(boolean b)
void	setTabIndex(int index)
void	setValue(java.lang.String value) Set the value of the text area
void	setWidth(java.lang.String width)

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

The input node CSS classname.

See Also:

Constant Field Values

id

public java.lang.String id

For internal use only. May be removed or replaced in the future.

client

public ApplicationConnection client

For internal use only. May be removed or replaced in the future.

immediate

public boolean immediate

For internal use only. May be removed or replaced in the future.

rta

public RichTextArea rta

For internal use only. May be removed or replaced in the future.

formatter

public VRichTextToolbar formatter

For internal use only. May be removed or replaced in the future.

html

public HTML html

For internal use only. May be removed or replaced in the future.

maxLength

public int maxLength

For internal use only. May be removed or replaced in the future.

keyPressHandler

public com.google.gwt.event.shared.HandlerRegistration keyPressHandler

For internal use only. May be removed or replaced in the future.

Constructor Detail

VRichTextArea

public VRichTextArea()

Method Detail

setEnabled

public void setEnabled(boolean enabled)

selectAll

public void selectAll()

For internal use only. May be removed or replaced in the future.

setReadOnly

public void setReadOnly(boolean b)

setHeight

public void setHeight(java.lang.String height)

setWidth

public void setWidth(java.lang.String width)

onKeyPress

public void onKeyPress(KeyPressEvent event)

onKeyDown

public void onKeyDown(KeyDownEvent event)

getTabIndex

public int getTabIndex()

setAccessKey

public void setAccessKey(char key)

setFocus

public void setFocus(boolean focused)

setTabIndex

public void setTabIndex(int index)

setValue

public void setValue(java.lang.String value)

Set the value of the text area

Parameters:

value - The text value. Can be html.

getValue

public java.lang.String getValue()

Get the value the text area

getSanitizedValue

public java.lang.String getSanitizedValue()

Browsers differ in what they return as the content of a visually empty rich text area. This method is used to normalize these to an empty string. See #8004.

Returns:

cleaned html string

addBlurHandler

public void addBlurHandler(BlurHandler blurHandler)

Adds a blur handler to the component.

Parameters:

blurHandler - the blur handler to add

removeBlurHandler

public void removeBlurHandler(BlurHandler blurHandler)

Removes a blur handler.

Parameters:

blurHandler - the handler to remove