---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

org.eclipse.jface.action
Class StatusLineContributionItem

java.lang.Object
  

org.eclipse.jface.action.ContributionItem
      
org.eclipse.jface.action.StatusLineContributionItem

All Implemented Interfaces:

IContributionItem

---

public class StatusLineContributionItem
extends 
ContributionItem

A contribution item to be used with status line managers.

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

Since:

3.4

---

Constructor Summary
StatusLineContributionItem ( String id)           Creates a status line contribution item with the given id.
StatusLineContributionItem ( String id, int charWidth)           Creates a status line contribution item with the given id that displays the given number of characters.

 

Method Summary
void	fill ( Composite parent)           The default implementation of this IContributionItem method does nothing.
Point	getDisplayLocation ()           An accessor for the current location of this status line contribution item -- relative to the display.
String	getText ()           Retrieves the text that is being displayed in the status line.
void	setText ( String text)           Sets the text to be displayed in the status line.

 

Methods inherited from class org.eclipse.jface.action. ContributionItem
dispose, fill, fill, fill, getId, getParent, isDirty, isDynamic, isEnabled, isGroupMarker, isSeparator, 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

StatusLineContributionItem

public StatusLineContributionItem(
String id)

Creates a status line contribution item with the given id.

Parameters:

id - the contribution item's id, or null if it is to have no id

---

StatusLineContributionItem

public StatusLineContributionItem(
String id,
                                  int charWidth)

Creates a status line contribution item with the given id that displays the given number of characters.

Parameters:

id - the contribution item's id, or null if it is to have no id

charWidth - the number of characters to display

Method Detail

fill

public void fill(
Composite parent)

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:

parent - the parent control

---

getDisplayLocation

public 
Point getDisplayLocation()

An accessor for the current location of this status line contribution item -- relative to the display.

Returns:

The current location of this status line; null if not yet initialized.

---

getText

public 
String getText()

Retrieves the text that is being displayed in the status line.

Returns:

the text that is currently being displayed

---

setText

public void setText(
String text)

Sets the text to be displayed in the status line.

Parameters:

text - the text to be displayed, must not be null

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.