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

Class AbstractToggleFeatureBehavior

java.lang.Object

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

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

All Implemented Interfaces:

com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.shared.EventHandler, AttributeReadEnabled, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteVisible, FeatureBehavior, AttributeReadValue<Boolean>, AttributeWriteValue<Boolean>

Direct Known Subclasses:

FeatureBehaviorBold, FeatureBehaviorItalic, FeatureBehaviorStrikethrough, FeatureBehaviorSubscript, FeatureBehaviorSuperscript, FeatureBehaviorUnderline

abstract class AbstractToggleFeatureBehavior
extends AbstractFeatureBehavior
implements com.google.gwt.event.dom.client.ClickHandler, AttributeWriteValue<Boolean>

The abstract base implementation of a FeatureBehavior for a feature that has a Boolean state that is toggled if toolbar widget is clicked.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gwt.user.client.ui.CheckBox	fontSettingsWidget
private SimpleToggleButton	toolbarWidget

Constructor Summary

Constructors

Constructor and Description
AbstractToggleFeatureBehavior(RichTextToolbar richTextToolbar) The constructor.

Method Summary

Modifier and Type	Method and Description
void	applyFontSettings() Updates the RichTextArea according to the value from the widget for the font-settings.
com.google.gwt.user.client.ui.CheckBox	getFontSettingsWidget()
SimpleToggleButton	getToolbarWidget()
protected boolean	hasFontSettingsWidget()
boolean	isEnabled()
void	onClick(com.google.gwt.event.dom.client.ClickEvent event)
void	setEnabled(boolean enabled)
void	setFontSettingsPreviewElement(com.google.gwt.dom.client.Element element) Updates the RichTextArea according to the value from the widget for the font-settings.
void	setValue(Boolean value) This method sets the value.
protected abstract void	toggle() Toggles the feature.
void	updateFontSettings() Updates the value of the widget for the font-settings according to the state of the RichTextArea.
protected abstract void	updateFontSettings(boolean checked, com.google.gwt.dom.client.Style style)
void	updateFontSettings(com.google.gwt.dom.client.Style style)
void	updateToolbar() Updates the status of the FeatureBehavior in the toolbar widget after a change.

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

createFontSettingsLabel, createId, getFontSettingsLabel, getFormatter, getIconMarkup, getLocalizedLabel, getRichTextToolbar, isVisible, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadValue

getValue

Methods inherited from interface net.sf.mmm.client.ui.gwt.widgets.richtext.FeatureBehavior

getFeature

Field Detail

toolbarWidget

private final SimpleToggleButton toolbarWidget

See Also:

getToolbarWidget()

fontSettingsWidget

private com.google.gwt.user.client.ui.CheckBox fontSettingsWidget

See Also:

getFontSettingsWidget()

Constructor Detail

AbstractToggleFeatureBehavior

public AbstractToggleFeatureBehavior(RichTextToolbar richTextToolbar)

The constructor.

Parameters:

richTextToolbar - is the RichTextToolbar owning this FeatureBehavior.

Method Detail

updateToolbar

public void updateToolbar()

Updates the status of the FeatureBehavior in the toolbar widget after a change. E.g. toggle buttons are updated to reflect the current state.

Specified by:

updateToolbar in interface FeatureBehavior

Overrides:

updateToolbar in class AbstractFeatureBehavior

updateFontSettings

public void updateFontSettings()

Updates the value of the widget for the font-settings according to the state of the RichTextArea.

Specified by:

updateFontSettings in interface FeatureBehavior

Overrides:

updateFontSettings in class AbstractFeatureBehavior

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface AttributeReadEnabled

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface AttributeWriteEnabled

getFontSettingsWidget

public com.google.gwt.user.client.ui.CheckBox getFontSettingsWidget()

Specified by:

getFontSettingsWidget in interface FeatureBehavior

Overrides:

getFontSettingsWidget in class AbstractFeatureBehavior

Returns:

the Widget for the feature in the RichTextToolbar.FontSettingsPopup.

setFontSettingsPreviewElement

public void setFontSettingsPreviewElement(com.google.gwt.dom.client.Element element)

Updates the RichTextArea according to the value from the widget for the font-settings.

Specified by:

setFontSettingsPreviewElement in interface FeatureBehavior

Overrides:

setFontSettingsPreviewElement in class AbstractFeatureBehavior

Parameters:

element - is the Element where to apply font settings whenever the value changed.

updateFontSettings

public void updateFontSettings(com.google.gwt.dom.client.Style style)

Parameters:

style - the Style to update.

updateFontSettings

protected abstract void updateFontSettings(boolean checked,
                                           com.google.gwt.dom.client.Style style)

Parameters:

checked - - the value of the checkbox.

style - the Style to update.

hasFontSettingsWidget

protected boolean hasFontSettingsWidget()

Overrides:

hasFontSettingsWidget in class AbstractFeatureBehavior

Returns:

true if the font settings widget is available and has already been created, false otherwise.

getToolbarWidget

public SimpleToggleButton getToolbarWidget()

Specified by:

getToolbarWidget in interface FeatureBehavior

setValue

public void setValue(Boolean value)

This method sets the value.

Specified by:

setValue in interface AttributeWriteValue<Boolean>

Parameters:

value - is the new value. May be null unless otherwise stated.

onClick

public void onClick(com.google.gwt.event.dom.client.ClickEvent event)

Specified by:

onClick in interface com.google.gwt.event.dom.client.ClickHandler

applyFontSettings

public void applyFontSettings()

Updates the RichTextArea according to the value from the widget for the font-settings.

Specified by:

applyFontSettings in interface FeatureBehavior

Overrides:

applyFontSettings in class AbstractFeatureBehavior

toggle

protected abstract void toggle()

Toggles the feature.