net.sf.mmm.client.ui.gwt.widgets.richtext

Class RichTextToolbar

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.FlowPanel

net.sf.mmm.client.ui.gwt.widgets.Toolbar

net.sf.mmm.client.ui.gwt.widgets.richtext.RichTextToolbar

All Implemented Interfaces:

com.google.gwt.event.dom.client.FocusHandler, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.KeyUpHandler, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, ButtonContainer

public class RichTextToolbar
extends Toolbar

This class is a Widget that represents the toolbar for a RichTextArea. The toolbar allows to format the selected text or insert images, hyperlinks, etc.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	RichTextToolbar.FontSettingsPopup The PopupWindow for the font settings.
private class	RichTextToolbar.UpdateHandler This class is the handler to update the toolbar buttons, etc.

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
private Map<RichTextFeature,FeatureBehavior>	behaviorMap
private NlsBundleClientUiRoot	bundle The NlsBundleClientUiRoot for NLS.
private static com.google.gwt.user.client.ui.RichTextArea.FontSize[]	FONT_SIZES The available font sizes.
private RichTextToolbar.FontSettingsPopup	fontSettingsPopup
private com.google.gwt.user.client.ui.RichTextArea.Formatter	formatter The RichTextArea.Formatter for the RichTextArea.
private com.google.gwt.user.client.ui.RichTextArea	richTextArea The associated RichTextArea to modify via this toolbar.

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
RichTextToolbar(com.google.gwt.user.client.ui.RichTextArea richTextArea) Creates a new toolbar that drives the given rich text area.

Method Summary

Modifier and Type	Method and Description
private void	addBehavior(FeatureBehavior behavior)
protected void	addFeatureBehaviors() Adds all available FeatureBehaviors at construction time.
private void	createButtonGroup(RichTextFeature... features) Creates a new ButtonGroup with buttons for the given RichTextFeatures.
private FeatureBehavior	getBehavior(RichTextFeature feature)
private RichTextToolbar.FontSettingsPopup	getFontSettingsPopup()
(package private) com.google.gwt.user.client.ui.RichTextArea.Formatter	getFormatter()
protected void	invokeFeature(RichTextFeature feature)
(package private) void	openFontSettingsPopup() Opens a popup with the font related feature settings.
void	setEnabled(boolean enabled)
void	setFeatureAvailable(RichTextFeature feature, boolean available) Sets the given RichTextFeature to the given availability.
private void	updateFontSettings() Updates the status of the RichTextToolbar.FontSettingsPopup.
private void	updateToolbar() Updates the status of the toolbar (with all the toggle buttons).

Methods inherited from class net.sf.mmm.client.ui.gwt.widgets.Toolbar

add, addBlurHandler, addFocusHandler, endGroup, onFocus, onKeyUp, startGroup

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

clear, insert, insert

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

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, 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, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

FONT_SIZES

private static final com.google.gwt.user.client.ui.RichTextArea.FontSize[] FONT_SIZES

The available font sizes.

richTextArea

private final com.google.gwt.user.client.ui.RichTextArea richTextArea

The associated RichTextArea to modify via this toolbar.

formatter

private final com.google.gwt.user.client.ui.RichTextArea.Formatter formatter

The RichTextArea.Formatter for the RichTextArea.

behaviorMap

private final Map<RichTextFeature,FeatureBehavior> behaviorMap

See Also:

getBehavior(RichTextFeature)

bundle

private final NlsBundleClientUiRoot bundle

The NlsBundleClientUiRoot for NLS.

fontSettingsPopup

private RichTextToolbar.FontSettingsPopup fontSettingsPopup

See Also:

getFontSettingsPopup()

Constructor Detail

RichTextToolbar

public RichTextToolbar(com.google.gwt.user.client.ui.RichTextArea richTextArea)

Creates a new toolbar that drives the given rich text area.

Parameters:

richTextArea - the rich text area to be controlled

Method Detail

addFeatureBehaviors

protected void addFeatureBehaviors()

Adds all available FeatureBehaviors at construction time.

addBehavior

private void addBehavior(FeatureBehavior behavior)

Parameters:

behavior - the FeatureBehavior to register in the internal Map.

getBehavior

private FeatureBehavior getBehavior(RichTextFeature feature)

Parameters:

feature - is the RichTextFeature.

Returns:

the FeatureBehavior for the given RichTextFeature. Invoking getFeature() on the result has to return the given RichTextFeature.

getFormatter

com.google.gwt.user.client.ui.RichTextArea.Formatter getFormatter()

Returns:

the RichTextArea.Formatter instance of the RichTextArea.

getFontSettingsPopup

private RichTextToolbar.FontSettingsPopup getFontSettingsPopup()

Returns:

the RichTextToolbar.FontSettingsPopup. Lazily created on the first call.

openFontSettingsPopup

void openFontSettingsPopup()

Opens a popup with the font related feature settings.

createButtonGroup

private void createButtonGroup(RichTextFeature... features)

Creates a new ButtonGroup with buttons for the given RichTextFeatures.

Parameters:

features - are the RichTextFeatures to create buttons for.

invokeFeature

protected void invokeFeature(RichTextFeature feature)

Parameters:

feature - is the RichTextFeature to invoke (e.g. if according button has been clicked).

setFeatureAvailable

public void setFeatureAvailable(RichTextFeature feature,
                                boolean available)

Sets the given RichTextFeature to the given availability.

Parameters:

feature - is the RichTextFeature.

available - - true if the given feature should be available (button visible), false otherwise.

updateToolbar

private void updateToolbar()

Updates the status of the toolbar (with all the toggle buttons).

updateFontSettings

private void updateFontSettings()

Updates the status of the RichTextToolbar.FontSettingsPopup.

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - - true to enable, false to disable.