|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.fieldassist.FieldDecoration
FieldDecoration is a simple data structure class for specifying a decoration for a field. A decoration may be rendered in different ways depending on the type of field it is used with.
FieldDecorationRegistry
Constructor Summary | |
---|---|
FieldDecoration(Image image,
String description)
Create a decoration for a field with the specified image and description text. |
Method Summary | |
---|---|
String |
getDescription()
Return the description for the decoration shown when the user hovers over the decoration. |
Image |
getImage()
Return the image shown in the decoration, or null if no
image is specified. |
void |
setDescription(String description)
Set the description for the decoration shown when the user hovers over the decoration. |
void |
setImage(Image image)
Set the image shown in the decoration, or null if no image
is specified. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FieldDecoration(Image image, String description)
image
- the image shown in the decoration. A null
image
will result in a blank decoration, which may be used to
reserve space near the field.description
- the description shown when the user hovers over the
decoration. A null
description indicates that
there will be no hover for the decoration.Method Detail |
public Image getImage()
null
if no
image is specified.
null
signifies a blank decoration.public void setImage(Image image)
null
if no image
is specified. It is up to the caller to update any decorated fields that
are showing the description in order to display the new image.
image
- the image shown in the decoration. A value of
null
signifies a blank decoration.public String getDescription()
null
indicates that no description will be shown.public void setDescription(String description)
description
- the String description of the decoration. A value of
null
indicates that no description will be
shown.
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.