Package org.eclipse.jface.viewers
Class ViewerLabel
- java.lang.Object
-
- org.eclipse.jface.viewers.ViewerLabel
-
public class ViewerLabel extends Object
The ViewerLabel is the class that is passed to a viewer to handle updates of labels. It keeps track of both original and updates text.- Since:
- 3.0
- See Also:
IViewerLabelProvider
-
-
Constructor Summary
Constructors Constructor Description ViewerLabel(String initialText, Image initialImage)Create a new instance of the receiver with the supplied initial text and image.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColorgetBackground()Get the background Color.FontgetFont()Get the font.ColorgetForeground()Get the foreground Color.ImagegetImage()Get the image for the receiver.StringgetText()Get the text for the receiver.ColorgetTooltipBackgroundColor()Return the tool tip background color.ColorgetTooltipForegroundColor()Return the foregroundColor.PointgetTooltipShift()StringgetTooltipText()Returns the tooltipText.booleanhasNewBackground()Return whether or not the background color has been set.booleanhasNewFont()Return whether or not the font has been set.booleanhasNewForeground()Return whether or not the foreground color has been set.booleanhasNewImage()Return whether or not the image has been set.booleanhasNewText()Return whether or not the text has been set.booleanhasNewTooltipBackgroundColor()Return whether or not the tool tip background color has been set.booleanhasNewTooltipForegroundColor()Return whether or not the tool tip foreground color has been set.booleanhasNewTooltipText()Return whether or not the tool tip text has been set.booleanhasTooltipShift()voidsetBackground(Color background)Set the background Color.voidsetFont(Font font)Set the font.voidsetForeground(Color foreground)Set the foreground Color.voidsetImage(Image image)Set the image for the receiver.voidsetText(String text)Set the text for the receiver.voidsetTooltipBackgroundColor(Color tooltipBackgroundColor)Set the backgroundColorfor tool tip.voidsetTooltipForegroundColor(Color tooltipForegroundColor)Set the foregroundColorfor tool tip.voidsetTooltipShift(Point tooltipShift)voidsetTooltipText(String tooltipText)Set the tool tip text.
-
-
-
Method Detail
-
getImage
public final Image getImage()
Get the image for the receiver. If the new image has been set return it, otherwise return the starting image.- Returns:
- Returns the image.
-
setImage
public final void setImage(Image image)
Set the image for the receiver.- Parameters:
image- The image to set.
-
getText
public final String getText()
Get the text for the receiver. If the new text has been set return it, otherwise return the starting text.- Returns:
- String or
nullif there was no initial text and nothing was updated.
-
setText
public final void setText(String text)
Set the text for the receiver.- Parameters:
text- String The label to set. This value should not benull.- See Also:
hasNewText()
-
hasNewImage
public boolean hasNewImage()
Return whether or not the image has been set.- Returns:
- boolean.
trueif the image has been set to something new. - Since:
- 3.1
-
hasNewText
public boolean hasNewText()
Return whether or not the text has been set.- Returns:
- boolean.
trueif the text has been set to something new.
-
hasNewBackground
public boolean hasNewBackground()
Return whether or not the background color has been set.- Returns:
- boolean.
trueif the value has been set.
-
hasNewForeground
public boolean hasNewForeground()
Return whether or not the foreground color has been set.- Returns:
- boolean.
trueif the value has been set. - Since:
- 3.1
-
hasNewFont
public boolean hasNewFont()
Return whether or not the font has been set.- Returns:
- boolean.
trueif the value has been set. - Since:
- 3.1
-
getBackground
public Color getBackground()
Get the background Color.- Returns:
- Color or
nullif no new value was set. - Since:
- 3.1
-
setBackground
public void setBackground(Color background)
Set the background Color.- Parameters:
background- Color. This value should not benull.- Since:
- 3.1
-
getFont
public Font getFont()
Get the font.- Returns:
- Font or
nullif no new value was set. - Since:
- 3.1
-
setFont
public void setFont(Font font)
Set the font.- Parameters:
font- Font This value should not benull.- Since:
- 3.1
-
getForeground
public Color getForeground()
Get the foreground Color.- Returns:
- Color or
nullif no new value was set. - Since:
- 3.1
-
setForeground
public void setForeground(Color foreground)
Set the foreground Color.- Parameters:
foreground- Color This value should not benull.- Since:
- 3.1
-
getTooltipText
public String getTooltipText()
Returns the tooltipText.- Returns:
Stringornullif the tool tip text was never set.- Since:
- 3.3
-
setTooltipText
public void setTooltipText(String tooltipText)
Set the tool tip text.- Parameters:
tooltipText- The tooltipTextStringto set. This value should not benull.- Since:
- 3.3
-
hasNewTooltipText
public boolean hasNewTooltipText()
Return whether or not the tool tip text has been set.- Returns:
boolean.trueif the tool tip text has been set.- Since:
- 3.3
-
getTooltipBackgroundColor
public Color getTooltipBackgroundColor()
Return the tool tip background color.- Returns:
Colorornullif the tool tip background color has not been set.- Since:
- 3.3
-
setTooltipBackgroundColor
public void setTooltipBackgroundColor(Color tooltipBackgroundColor)
Set the backgroundColorfor tool tip.- Parameters:
tooltipBackgroundColor- TheColorto set. This value should not benull.- Since:
- 3.3
-
hasNewTooltipBackgroundColor
public boolean hasNewTooltipBackgroundColor()
Return whether or not the tool tip background color has been set.- Returns:
boolean.trueif the tool tip text has been set.- Since:
- 3.3
-
getTooltipForegroundColor
public Color getTooltipForegroundColor()
Return the foregroundColor.- Returns:
- Returns
Colorornullif the tool tip foreground color has not been set. - Since:
- 3.3
-
setTooltipForegroundColor
public void setTooltipForegroundColor(Color tooltipForegroundColor)
Set the foregroundColorfor tool tip.- Parameters:
tooltipForegroundColor- The tooltipForegroundColor to set.- Since:
- 3.3
-
hasNewTooltipForegroundColor
public boolean hasNewTooltipForegroundColor()
Return whether or not the tool tip foreground color has been set.- Returns:
boolean.trueif the tool tip foreground has been set.- Since:
- 3.3
-
getTooltipShift
public Point getTooltipShift()
- Returns:
- Returns the tooltipShift.
- Since:
- 3.3
-
setTooltipShift
public void setTooltipShift(Point tooltipShift)
- Parameters:
tooltipShift- The tooltipShift to set.- Since:
- 3.3
-
hasTooltipShift
public boolean hasTooltipShift()
- Returns:
- Return whether or not the tool tip shift has been set.
- Since:
- 3.3
-
-