Package org.eclipse.jface.action

Class Separator

java.lang.Object

org.eclipse.jface.action.ContributionItem

org.eclipse.jface.action.AbstractGroupMarker

org.eclipse.jface.action.Separator

All Implemented Interfaces:

IContributionItem

public class Separator
extends AbstractGroupMarker

A separator is a special kind of contribution item which acts as a visual separator and, optionally, acts as a group marker. Unlike group markers, separators do have a visual representation for menus and toolbars.

This class may be instantiated; it is not intended to be subclassed outside the framework.

Restriction:

This class is not intended to be subclassed by clients.

Constructor Summary

Constructors

Constructor	Description
Separator()	Creates a separator which does not start a new group.
Separator(String groupName)	Creates a new separator which also defines a new group having the given group name.

Method Summary

Modifier and Type	Method	Description
void	fill(Menu menu, int index)	The default implementation of this IContributionItem method does nothing.
void	fill(ToolBar toolbar, int index)	The default implementation of this IContributionItem method does nothing.
boolean	isSeparator()	The Separator implementation of this IContributionItem method returns true

Methods inherited from class org.eclipse.jface.action.AbstractGroupMarker

getGroupName, isEnabled, isGroupMarker

Methods inherited from class org.eclipse.jface.action.ContributionItem

dispose, fill, fill, getId, getParent, isDirty, isDynamic, isVisible, saveWidgetState, setId, setParent, setVisible, toString, update, update

Methods inherited from class java.lang.Object

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

Constructor Detail

Separator

public Separator()

Creates a separator which does not start a new group.

Separator

public Separator(String groupName)

Creates a new separator which also defines a new group having the given group name. The group name must not be null or the empty string. The group name is also used as the item id.

Parameters:

groupName - the group name of the separator

Method Detail

fill

public void fill(Menu menu,
                 int index)

Description copied from class: ContributionItem

The default implementation of this IContributionItem method does nothing. Subclasses may override.

Specified by:

fill in interface IContributionItem

Overrides:

fill in class ContributionItem

Parameters:

menu - the parent menu

index - the index where the controls are inserted, or -1 to insert at the end

fill

public void fill(ToolBar toolbar,
                 int index)

Description copied from class: ContributionItem

The default implementation of this IContributionItem method does nothing. Subclasses may override.

Specified by:

fill in interface IContributionItem

Overrides:

fill in class ContributionItem

Parameters:

toolbar - the parent tool bar

index - the index where the controls are inserted, or -1 to insert at the end

isSeparator

public boolean isSeparator()

The Separator implementation of this IContributionItem method returns true

Specified by:

isSeparator in interface IContributionItem

Overrides:

isSeparator in class ContributionItem

Returns:

true if this item is a separator, and false for normal items

See Also:

Separator