org.eclipse.epf.richtext
Interface IRichTextToolBar

All Known Implementing Classes:

RichTextToolBar

public interface IRichTextToolBar

The interface for a rich text editor toolbar.

Since:

1.0

Author:

Kelvin Low

Method Summary

void	addAction(IRichTextAction action) Adds a button action to the tool bar.
void	addAction(IRichTextComboAction action) Adds a combo action to the tool bar.
void	addSeparator() Adds a separator to the tool bar.
void	setEnabled(boolean enabled) Updates the actionable states of the tool buttons in the tool bar.

Method Detail

addAction

public void addAction(IRichTextAction action)

Adds a button action to the tool bar.

Parameters:

action - the button action to add

addAction

public void addAction(IRichTextComboAction action)

Adds a combo action to the tool bar.

Parameters:

action - the combo action to add

addSeparator

public void addSeparator()

Adds a separator to the tool bar.

setEnabled

public void setEnabled(boolean enabled)

Updates the actionable states of the tool buttons in the tool bar.

The tool buttons in the rich text editor tool bar are shared by the rich text and markup language tab. This method provides a way for the tool buttons to be enabled or disabled based on (1) the tab selection and (2) the editable state of the editor.

Parameters:

enabled - if true, enables all tool buttons; if false, disables all tool buttons except for those that are still applicable even when the editor is read-only