|
 |
|
| |
org.eclipse.ui.actions
Class CompoundContributionItem
java.lang.Object
org.eclipse.jface.action.ContributionItem
org.eclipse.ui.actions.CompoundContributionItem
-
All Implemented Interfaces:
-
IContributionItem
-
Direct Known Subclasses:
-
BaseNewWizardMenu
-
public abstract class CompoundContributionItem
- extends
ContributionItem
A compound contribution is a contribution item consisting of a
dynamic list of contribution items.
-
Since:
- 3.1
|
Method Summary
|
void
|
fill
(
Menu menu,
int index)
The default implementation of this IContributionItem
method does nothing. |
protected abstract
IContributionItem[]
|
getContributionItems
()
Return a list of contributions items that will replace this item in the
parent manager. |
boolean
|
isDirty
()
The default implementation of this IContributionItem
method returns false. |
boolean
|
isDynamic
()
The default implementation of this IContributionItem
method returns false. |
void
|
setParent
(
IContributionManager parent)
Sets the parent manager of this item |
|
Methods inherited from class org.eclipse.jface.action.
ContributionItem
|
dispose,
fill,
fill,
fill,
getId,
getParent,
isEnabled,
isGroupMarker,
isSeparator,
isVisible,
saveWidgetState,
setId,
setVisible,
toString,
update,
update
|
CompoundContributionItem
protected CompoundContributionItem()
- Creates a compound contribution item with a
null id.
CompoundContributionItem
protected CompoundContributionItem(
String id)
- Creates a compound contribution item with the given (optional) id.
-
Parameters:
-
id - the contribution item identifier, or null
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
getContributionItems
protected abstract
IContributionItem[] getContributionItems()
- Return a list of contributions items that will replace this item in the
parent manager. The list must contain new contribution items every call
since the old ones will be disposed.
-
-
Returns:
- an array list of items to display. Must not be
null.
isDirty
public boolean isDirty()
-
Description copied from class:
ContributionItem
- The default implementation of this
IContributionItem
method returns false. Subclasses may override.
-
-
Specified by:
-
isDirty
in interface
IContributionItem
-
Overrides:
-
isDirty
in class
ContributionItem
-
-
Returns:
-
true if this item is dirty
isDynamic
public boolean isDynamic()
-
Description copied from class:
ContributionItem
- The default implementation of this
IContributionItem
method returns false. Subclasses may override.
-
-
Specified by:
-
isDynamic
in interface
IContributionItem
-
Overrides:
-
isDynamic
in class
ContributionItem
-
-
Returns:
-
true if this item is dynamic, and
false for normal items
setParent
public void setParent(
IContributionManager parent)
-
Description copied from interface:
IContributionItem
- Sets the parent manager of this item
-
-
Specified by:
-
setParent
in interface
IContributionItem
-
Overrides:
-
setParent
in class
ContributionItem
-
-
Parameters:
-
parent - the parent contribution manager
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
