org.eclipse.paho.mqtt.ui.support.fieldassist

Class ControlDecorationUpdater

java.lang.Object

org.eclipse.paho.mqtt.ui.support.fieldassist.ControlDecorationUpdater

public class ControlDecorationUpdater
extends Object

Controls the appearance of a ControlDecoration managed by a ControlDecorationSupport.

Since:

1.4

Constructor Summary

Constructors

Constructor and Description
ControlDecorationUpdater()

Method Summary

Modifier and Type	Method and Description
protected String	getDescriptionText(org.eclipse.core.runtime.IStatus status) Returns the description text to show in a ControlDecoration for the given status.
protected org.eclipse.swt.graphics.Image	getImage(org.eclipse.core.runtime.IStatus status) Returns an image to display in a ControlDecoration which is appropriate for the given status.
protected void	update(org.eclipse.jface.fieldassist.ControlDecoration decoration, org.eclipse.core.runtime.IStatus status) Updates the visibility, image, and description text of the given ControlDecoration to represent the given status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ControlDecorationUpdater

public ControlDecorationUpdater()

Method Detail

update

protected void update(org.eclipse.jface.fieldassist.ControlDecoration decoration,
                      org.eclipse.core.runtime.IStatus status)

Updates the visibility, image, and description text of the given ControlDecoration to represent the given status.

Parameters:

decoration - the ControlDecoration to update

status - the status to be displayed by the decoration

getDescriptionText

protected String getDescriptionText(org.eclipse.core.runtime.IStatus status)

Returns the description text to show in a ControlDecoration for the given status. The default implementation of this method returns status.getMessage().

Parameters:

status - the status object.

Returns:

the description text to show in a ControlDecoration for the given status.

getImage

protected org.eclipse.swt.graphics.Image getImage(org.eclipse.core.runtime.IStatus status)

Returns an image to display in a ControlDecoration which is appropriate for the given status. The default implementation of this method returns an image according to status.getSeverity():

• IStatus.OK => No image
• IStatus.INFO => FieldDecorationRegistry.DEC_INFORMATION
• IStatus.WARNING => FieldDecorationRegistry.DEC_WARNING
• IStatus.ERROR => FieldDecorationRegistry.DEC_ERROR
• IStatus.CANCEL => FieldDecorationRegistry.DEC_ERROR
• Other => No image

Parameters:

status - the status object.

Returns:

an image to display in a ControlDecoration which is appropriate for the given status.