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

Class AbstractFeatureBehavior

java.lang.Object

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

All Implemented Interfaces:

AttributeReadEnabled, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteVisible, FeatureBehavior

Direct Known Subclasses:

AbstractClickFeatureBehavior, AbstractToggleFeatureBehavior

abstract class AbstractFeatureBehavior
extends Object
implements FeatureBehavior

This is the abstract base implementation of FeatureBehavior.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private RichTextToolbar	richTextToolbar
private boolean	visible

Constructor Summary

Constructors

Constructor and Description
AbstractFeatureBehavior(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.
protected LabelWidget	createFontSettingsLabel()
protected String	createId(String suffix)
LabelWidget	getFontSettingsLabel()
com.google.gwt.user.client.ui.Widget	getFontSettingsWidget()
protected com.google.gwt.user.client.ui.RichTextArea.Formatter	getFormatter()
protected com.google.gwt.safehtml.shared.SafeHtml	getIconMarkup()
protected String	getLocalizedLabel()
protected RichTextToolbar	getRichTextToolbar()
protected boolean	hasFontSettingsWidget()
boolean	isVisible() This method determines if this object is set to visible.
void	setFontSettingsPreviewElement(com.google.gwt.dom.client.Element element) Updates the RichTextArea according to the value from the widget for the font-settings.
void	setVisible(boolean visible) This method shows or hides this object.
void	updateFontSettings() Updates the value of the widget for the font-settings according to the state of the RichTextArea.
void	updateToolbar() Updates the status of the FeatureBehavior in the toolbar widget after a change.

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.client.ui.gwt.widgets.richtext.FeatureBehavior

getFeature, getToolbarWidget

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteEnabled

setEnabled

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadEnabled

isEnabled

Field Detail

richTextToolbar

private final RichTextToolbar richTextToolbar

See Also:

getRichTextToolbar()

visible

private boolean visible

See Also:

isVisible()

Constructor Detail

AbstractFeatureBehavior

public AbstractFeatureBehavior(RichTextToolbar richTextToolbar)

The constructor.

Parameters:

richTextToolbar - is the RichTextToolbar owning this FeatureBehavior.

Method Detail

getRichTextToolbar

protected RichTextToolbar getRichTextToolbar()

Returns:

the richTextToolbar

getFormatter

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

Returns:

the RichTextArea.Formatter of the RichTextArea of the getRichTextToolbar().

isVisible

public boolean isVisible()

This method determines if this object is set to visible.

Specified by:

isVisible in interface AttributeReadVisible

Returns:

true if programmatically set visible, false if directly programmatically hidden.

See Also:

AttributeReadVisibleRecursive.isVisibleRecursive()

setVisible

public final void setVisible(boolean visible)

This method shows or hides this object.

Specified by:

setVisible in interface AttributeWriteVisible

Parameters:

visible - is the new visibility status of this object. If true, the object will be shown (and raised), if false the object will be hidden (iconified).

See Also:

AttributeReadVisible.isVisible()

hasFontSettingsWidget

protected boolean hasFontSettingsWidget()

Returns:

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

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

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

applyFontSettings

public void applyFontSettings()

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

Specified by:

applyFontSettings in interface FeatureBehavior

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

Parameters:

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

getLocalizedLabel

protected String getLocalizedLabel()

Returns:

the localized label text of the feature.

createId

protected String createId(String suffix)

Parameters:

suffix - a suffix unique for the Widget to identify within the RichTextToolbar.

Returns:

the HTML ID.

getIconMarkup

protected com.google.gwt.safehtml.shared.SafeHtml getIconMarkup()

Returns:

the SafeHtml with the markup for the icon of the feature button in the toolbar.

getFontSettingsWidget

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

Specified by:

getFontSettingsWidget in interface FeatureBehavior

Returns:

the Widget for the feature in the RichTextToolbar.FontSettingsPopup.

createFontSettingsLabel

protected LabelWidget createFontSettingsLabel()

Returns:

the new LabelWidget instance for getFontSettingsLabel().

See Also:

getFontSettingsLabel()

getFontSettingsLabel

public LabelWidget getFontSettingsLabel()

Specified by:

getFontSettingsLabel in interface FeatureBehavior

Returns:

the LabelWidget for the feature in the RichTextToolbar.FontSettingsPopup or null if not intended (e.g. toggle features use a CheckBox as popup widget and do not have a separate label).