StatusLineManager (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
2.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.action
Class StatusLineManager

java.lang.Object
  |
  +--org.eclipse.jface.action.ContributionManager
        |
        +--org.eclipse.jface.action.StatusLineManager

All Implemented Interfaces:: IContributionManager, IStatusLineManager

public class StatusLineManager
extends ContributionManager
implements IStatusLineManager

A status line manager is a contribution manager which realizes itself and its items in a status line control.

This class may be instantiated; it may also be subclassed if a more sophisticated layout is required.

Constructor Summary

StatusLineManager()
          Creates a new status line manager.

Method Summary

org.eclipse.jface.action.StatusLine createControl(Composite parent)
          Creates and returns this manager's status line control.

void dispose()
          Disposes of this status line manager and frees all allocated SWT resources.

Control getControl()
          Internal -- returns the StatusLine control.

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, String message)
          Sets the image and error message to be displayed on the status line.

void setErrorMessage(String message)
          Sets the error message text to be displayed on the status line.

void setMessage(Image image, String message)
          Sets the image and message to be displayed on the status line.

void setMessage(String message)
          Sets the message text to be displayed on the status line.

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.ContributionManager

add, add, appendToGroup, appendToGroup, dumpStatistics, find, getItems, getOverrides, hasDynamicItems, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll, setDirty, setOverrides

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

StatusLineManager

public StatusLineManager()

Creates a new status line manager. Use the createControl method to create the status line control.

Method Detail

createControl

public org.eclipse.jface.action.StatusLine createControl(Composite parent)

Creates and returns this manager's status line control. Does not create a new control if one already exists.

Parameters:: parent - the parent control
Returns:: the status line control

dispose

public void dispose()

Disposes of this status line manager and frees all allocated SWT resources. Note that this method does not clean up references between this status line manager and its associated contribution items. Use removeAll for that purpose.

getControl

public Control getControl()

Internal -- returns the StatusLine control.

This method is not intended to be used outside of the JFace framework.