Package org.eclipse.graphiti.tb
Class TextDecorator
- java.lang.Object
-
- org.eclipse.graphiti.tb.AbstractDecorator
-
- org.eclipse.graphiti.tb.TextDecorator
-
- All Implemented Interfaces:
ILocation
,IDecorator
,ITextDecorator
public class TextDecorator extends AbstractDecorator implements ITextDecorator
Text decorators can be used to add a text to the visualization of a shape without modifying the dirty state of the displaying editor, seeIDecorator
.- Since:
- 0.10
-
-
Constructor Summary
Constructors Constructor Description TextDecorator(java.lang.String text)
Creates a new text decorator that decorates a shape with the given text.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IColorConstant
getBackgroundColor()
Returns the color that will be used for painting the background of the shape to decorate.java.lang.String
getFontName()
Gets the name of the font used in the decorator.int
getFontSize()
Gets the size of the font used in the decorator.IColorConstant
getForegroundColor()
Returns the color that will be used for painting the foreground of the shape to decorate.java.lang.String
getText()
Returns the text of the decorator.int
getX()
Gets the x value.int
getY()
Gets the y value.void
setBackgroundColor(IColorConstant backgroundColor)
Sets the color that will be used for painting the background of the text.void
setFontName(java.lang.String fontName)
Sets the name of the font used in the decorator.void
setFontSize(int fontSize)
Sets the size of the font used in the decorator.void
setForegroundColor(IColorConstant foregroundColor)
Sets the color that will be used for painting the foreground of the text.void
setText(java.lang.String text)
Sets the text or the decorator.void
setX(int x)
Sets the x coordinate of this location.void
setY(int y)
Sets the y coordinate of this location.-
Methods inherited from class org.eclipse.graphiti.tb.AbstractDecorator
getMessage, setMessage
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.graphiti.tb.IDecorator
getMessage, setMessage
-
-
-
-
Constructor Detail
-
TextDecorator
public TextDecorator(java.lang.String text)
Creates a new text decorator that decorates a shape with the given text. The default font used for displaying the text is Arial in size 10, the text will appear by default 4px from the upper left corner of the decorated shape.- Parameters:
text
- aString
providing the text
-
-
Method Detail
-
getX
public int getX()
Description copied from interface:ILocation
Gets the x value.
-
getY
public int getY()
Description copied from interface:ILocation
Gets the y value.
-
setX
public void setX(int x)
Description copied from interface:ILocation
Sets the x coordinate of this location.
-
setY
public void setY(int y)
Description copied from interface:ILocation
Sets the y coordinate of this location.
-
getText
public java.lang.String getText()
Description copied from interface:ITextDecorator
Returns the text of the decorator.- Specified by:
getText
in interfaceITextDecorator
- Returns:
- A
String
containing the text
-
setText
public void setText(java.lang.String text)
Description copied from interface:ITextDecorator
Sets the text or the decorator.- Specified by:
setText
in interfaceITextDecorator
- Parameters:
text
- AString
containing the text
-
getFontName
public java.lang.String getFontName()
Description copied from interface:ITextDecorator
Gets the name of the font used in the decorator.- Specified by:
getFontName
in interfaceITextDecorator
- Returns:
- A
String
containing the name of the font.
-
setFontName
public void setFontName(java.lang.String fontName)
Description copied from interface:ITextDecorator
Sets the name of the font used in the decorator.- Specified by:
setFontName
in interfaceITextDecorator
- Parameters:
fontName
- AString
containing the name of the font.
-
getFontSize
public int getFontSize()
Description copied from interface:ITextDecorator
Gets the size of the font used in the decorator.- Specified by:
getFontSize
in interfaceITextDecorator
- Returns:
- An integer defining the size of the font.
-
setFontSize
public void setFontSize(int fontSize)
Description copied from interface:ITextDecorator
Sets the size of the font used in the decorator.- Specified by:
setFontSize
in interfaceITextDecorator
- Parameters:
fontSize
- An integer defining the size of the font.
-
getForegroundColor
public IColorConstant getForegroundColor()
Description copied from interface:ITextDecorator
Returns the color that will be used for painting the foreground of the shape to decorate. By default (when returningnull
) the original foreground color of the shape is kept.- Specified by:
getForegroundColor
in interfaceITextDecorator
- Returns:
- a
IColorConstant
defining the color
-
setForegroundColor
public void setForegroundColor(IColorConstant foregroundColor)
Description copied from interface:ITextDecorator
Sets the color that will be used for painting the foreground of the text. By default (when returningnull
) the original foreground color of the text is kept.- Specified by:
setForegroundColor
in interfaceITextDecorator
-
getBackgroundColor
public IColorConstant getBackgroundColor()
Description copied from interface:ITextDecorator
Returns the color that will be used for painting the background of the shape to decorate. By default (when returningnull
) the original background color of the shape is kept.- Specified by:
getBackgroundColor
in interfaceITextDecorator
- Returns:
- a
IColorConstant
defining the color
-
setBackgroundColor
public void setBackgroundColor(IColorConstant backgroundColor)
Description copied from interface:ITextDecorator
Sets the color that will be used for painting the background of the text. By default (when returningnull
) the original background color of the text is kept.- Specified by:
setBackgroundColor
in interfaceITextDecorator
-
-