|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.action.SubContributionManager
org.eclipse.jface.action.SubStatusLineManager
public class SubStatusLineManager
A SubStatusLineManager is used to define a set of contribution
items within a parent manager. Once defined, the visibility of the entire set can
be changed as a unit.
| Constructor Summary | |
|---|---|
SubStatusLineManager(IStatusLineManager mgr)
Constructs a new manager. |
|
| Method Summary | |
|---|---|
protected IStatusLineManager |
getParentStatusLineManager()
|
IProgressMonitor |
getProgressMonitor()
Returns a progress monitor which reports progress in the status line. |
boolean |
isCancelEnabled()
Returns whether the cancel button on the status line's progress monitor is enabled. |
void |
setCancelEnabled(boolean enabled)
Sets whether the cancel button on the status line's progress monitor is enabled. |
void |
setErrorMessage(Image image,
java.lang.String message)
Sets the image and error message to be displayed on the status line. |
void |
setErrorMessage(java.lang.String message)
Sets the error message text to be displayed on the status line. |
void |
setMessage(Image image,
java.lang.String message)
Sets the image and message to be displayed on the status line. |
void |
setMessage(java.lang.String message)
Sets the message text to be displayed on the status line. |
void |
setVisible(boolean visible)
Sets the visibility of the manager. |
void |
update(boolean force)
Updates this manager's underlying widget(s) with any changes which have been made to it or its items. |
| Methods inherited from class org.eclipse.jface.action.SubContributionManager |
|---|
add, add, appendToGroup, appendToGroup, disposeManager, find, getItems, getOverrides, getParent, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, isVisible, itemAdded, itemRemoved, items, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll, unwrap, wrap |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.jface.action.IContributionManager |
|---|
add, add, appendToGroup, appendToGroup, find, getItems, getOverrides, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll |
| Constructor Detail |
|---|
public SubStatusLineManager(IStatusLineManager mgr)
mgr - the parent manager. All contributions made to the
SubStatusLineManager are forwarded and appear in the
parent manager.| Method Detail |
|---|
protected final IStatusLineManager getParentStatusLineManager()
public IProgressMonitor getProgressMonitor()
IStatusLineManager
getProgressMonitor in interface IStatusLineManagerpublic boolean isCancelEnabled()
IStatusLineManager
isCancelEnabled in interface IStatusLineManagertrue if the cancel button is enabled, or false if notpublic void setCancelEnabled(boolean enabled)
IStatusLineManager
setCancelEnabled in interface IStatusLineManagerenabled - true if the cancel button is enabled, or false if notpublic void setErrorMessage(java.lang.String message)
IStatusLineManager
An error message overrides the current message until the error
message is cleared (set to null).
setErrorMessage in interface IStatusLineManagermessage - the error message, or null to clear
the current error message.
public void setErrorMessage(Image image,
java.lang.String message)
IStatusLineManager
An error message overrides the current message until the error
message is cleared (set to null).
setErrorMessage in interface IStatusLineManagerimage - the image to use, or null for no imagemessage - the error message, or null to clear
the current error message.public void setMessage(java.lang.String message)
IStatusLineManager
This method replaces the current message but does not affect the
error message. That is, the error message, if set, will continue
to be displayed until it is cleared (set to null).
setMessage in interface IStatusLineManagermessage - the message, or null for no message
public void setMessage(Image image,
java.lang.String message)
IStatusLineManager
This method replaces the current message but does not affect the
error message. That is, the error message, if set, will continue
to be displayed until it is cleared (set to null).
setMessage in interface IStatusLineManagerimage - the image to use, or null for no imagemessage - the message, or null for no messagepublic void setVisible(boolean visible)
SubContributionManagertrue
then each item within the manager appears within the parent manager.
Otherwise, the items are not visible.
setVisible in class SubContributionManagervisible - the new visibilitypublic void update(boolean force)
IContributionManager
update in interface IContributionManagerforce - true means update even if not dirty,
and false for normal incremental updating
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.