public class FieldDecoration extends Object
FieldDecorationRegistry
Constructor and Description |
---|
FieldDecoration(Image image,
String description)
Create a decoration for a field with the specified image and description
text.
|
Modifier and Type | Method and Description |
---|---|
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. |
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.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.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.