|
 |
|
| |
org.eclipse.jface.action
Class ControlContribution
java.lang.Object
org.eclipse.jface.action.ContributionItem
org.eclipse.jface.action.ControlContribution
-
All Implemented Interfaces:
-
IContributionItem
-
Direct Known Subclasses:
- org.eclipse.ui.internal.menus.InternalControlContribution
-
public abstract class ControlContribution
- extends
ContributionItem
An abstract contribution item implementation for adding an arbitrary
SWT control to a tool bar.
Note, however, that these items cannot be contributed to menu bars.
The createControl framework method must be implemented
by concrete subclasses.
|
Method Summary
|
protected int
|
computeWidth
(
Control control)
Computes the width of the given control which is being added
to a tool bar. |
protected abstract
Control
|
createControl
(
Composite parent)
Creates and returns the control for this contribution item
under the given parent composite. |
void
|
fill
(
Composite parent)
The control item implementation of this IContributionItem
method calls the createControl framework method. |
void
|
fill
(
Menu parent,
int index)
The control item implementation of this IContributionItem
method throws an exception since controls cannot be added to menus. |
void
|
fill
(
ToolBar parent,
int index)
The control item implementation of this IContributionItem
method calls the createControl framework method to
create a control under the given parent, and then creates
a new tool item to hold it. |
|
Methods inherited from class org.eclipse.jface.action.
ContributionItem
|
dispose,
fill,
getId,
getParent,
isDirty,
isDynamic,
isEnabled,
isGroupMarker,
isSeparator,
isVisible,
saveWidgetState,
setId,
setParent,
setVisible,
toString,
update,
update
|
ControlContribution
protected ControlContribution(
String id)
- Creates a control contribution item with the given id.
-
Parameters:
-
id - the contribution item id
computeWidth
protected int computeWidth(
Control control)
- Computes the width of the given control which is being added
to a tool bar. This is needed to determine the width of the tool bar item
containing the given control.
The default implementation of this framework method returns
control.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).x.
Subclasses may override if required.
-
-
Parameters:
-
control - the control being added
-
Returns:
- the width of the control
createControl
protected abstract
Control createControl(
Composite parent)
- Creates and returns the control for this contribution item
under the given parent composite.
This framework method must be implemented by concrete
subclasses.
-
-
Parameters:
-
parent - the parent composite
-
Returns:
- the new control
fill
public final void fill(
Composite parent)
- The control item implementation of this
IContributionItem
method calls the createControl framework method.
Subclasses must implement createControl rather than
overriding this method.
-
-
Specified by:
-
fill
in interface
IContributionItem
-
Overrides:
-
fill
in class
ContributionItem
-
-
Parameters:
-
parent - the parent control
fill
public final void fill(
Menu parent,
int index)
- The control item implementation of this
IContributionItem
method throws an exception since controls cannot be added to menus.
-
-
Specified by:
-
fill
in interface
IContributionItem
-
Overrides:
-
fill
in class
ContributionItem
-
-
Parameters:
-
parent - the parent menu -
index - the index where the controls are inserted,
or -1 to insert at the end
fill
public final void fill(
ToolBar parent,
int index)
- The control item implementation of this
IContributionItem
method calls the createControl framework method to
create a control under the given parent, and then creates
a new tool item to hold it.
Subclasses must implement createControl rather than
overriding this method.
-
-
Specified by:
-
fill
in interface
IContributionItem
-
Overrides:
-
fill
in class
ContributionItem
-
-
Parameters:
-
parent - the parent tool bar -
index - the index where the controls are inserted,
or -1 to insert at the end
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
