Package org.eclipse.birt.chart.event
Class TextRenderEvent
java.lang.Object
java.util.EventObject
org.eclipse.birt.chart.event.ChartEvent
org.eclipse.birt.chart.event.PrimitiveRenderEvent
org.eclipse.birt.chart.event.TextRenderEvent
- All Implemented Interfaces:
Serializable
,Comparable
- Direct Known Subclasses:
Text3DRenderEvent
A rendering event type for rendering text object.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
A constant used with the 'TextPosition' attribute.static final int
A constant used with the 'TextPosition' attribute.static final int
A constant used with the 'TextPosition' attribute.static final int
Renders a shadow offset with the encapsulating container rectangle's corner or edge aligned with a given point This action requires Label, Location, TextPosition to be setstatic final int
Renders text (with optional insets, border, fill, etc) with the encapsulating container rectangle's corner or edge aligning with a given point This action requires Label, Location, TextPosition to be setstatic final int
Renders text (with optional insets, border, fill, etc) with the encapsulating container rectangle's bounding box aligned with a parent block's bounds This action requires Label, BlockBounds, BlockAlignment to be setstatic final int
A constant used with the 'TextPosition' attribute.static final int
An undefined action that will result in an errorFields inherited from class org.eclipse.birt.chart.event.PrimitiveRenderEvent
DRAW, FILL, iObjIndex
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()
final void
draw
(IDeviceRenderer idr) Causes this instruction to 'draw' itself on the device renderervoid
fill
(IDeviceRenderer idr) Causes this instruction to 'fill' itself on the device rendererfinal int
final TextAlignment
final Bounds
final Label
getLabel()
final Location
final int
void
reset()
Resets the inner state of current event.final void
setAction
(int iAction) Sets the action of current event.final void
setBlockAlignment
(TextAlignment taBlock) Sets the block alignment of the text.final void
setBlockBounds
(Bounds boBlock) Sets the block bounds of the text.final void
Sets the label of the text.final void
setLocation
(Location lo) Sets the location of the text.final void
Adds the "RLE" and "PDF" unicode control characters to label caption where "RLE" is added to the beginning and "PDF" to the end to apply right to left reading orderfinal void
setTextPosition
(int iTextPosition) Sets the position of the text.final void
updateFrom
(LabelBlock lb, double dScale, RunTimeContext rtc) Updates the event by given LabelBlock object.Methods inherited from class org.eclipse.birt.chart.event.PrimitiveRenderEvent
compareRegular, compareTo, compareTransposed, getBackground, getBounds, getDepth, getLineAttributes, isEnabled, setDepth, setEnable
Methods inherited from class org.eclipse.birt.chart.event.ChartEvent
setSourceObject
Methods inherited from class java.util.EventObject
getSource, toString
-
Field Details
-
UNDEFINED
public static final int UNDEFINEDAn undefined action that will result in an error- See Also:
-
RENDER_SHADOW_AT_LOCATION
public static final int RENDER_SHADOW_AT_LOCATIONRenders a shadow offset with the encapsulating container rectangle's corner or edge aligned with a given point This action requires Label, Location, TextPosition to be set- See Also:
-
RENDER_TEXT_AT_LOCATION
public static final int RENDER_TEXT_AT_LOCATIONRenders text (with optional insets, border, fill, etc) with the encapsulating container rectangle's corner or edge aligning with a given point This action requires Label, Location, TextPosition to be set- See Also:
-
RENDER_TEXT_IN_BLOCK
public static final int RENDER_TEXT_IN_BLOCKRenders text (with optional insets, border, fill, etc) with the encapsulating container rectangle's bounding box aligned with a parent block's bounds This action requires Label, BlockBounds, BlockAlignment to be set- See Also:
-
LEFT
public static final int LEFTA constant used with the 'TextPosition' attribute. This indicates that the text is positioned to the left of the reference point 'Location'- See Also:
-
RIGHT
public static final int RIGHTA constant used with the 'TextPosition' attribute. This indicates that the text is positioned to the right of the reference point 'Location'- See Also:
-
ABOVE
public static final int ABOVEA constant used with the 'TextPosition' attribute. This indicates that the text is positioned above the reference point 'Location'- See Also:
-
BELOW
public static final int BELOWA constant used with the 'TextPosition' attribute. This indicates that the text is positioned below the reference point 'Location'- See Also:
-
-
Constructor Details
-
TextRenderEvent
The constructor.
-
-
Method Details
-
setBlockBounds
Sets the block bounds of the text. -
setRtlCaption
public final void setRtlCaption()Adds the "RLE" and "PDF" unicode control characters to label caption where "RLE" is added to the beginning and "PDF" to the end to apply right to left reading order -
getBlockBounds
- Returns:
- Returns the block bounds of the text.
-
setLabel
Sets the label of the text. -
getLabel
- Overrides:
getLabel
in classPrimitiveRenderEvent
- Returns:
- Returns the label of the text.
-
setBlockAlignment
Sets the block alignment of the text. -
getBlockAlignment
- Returns:
- Returns the block alignment of the text.
-
setAction
public final void setAction(int iAction) Sets the action of current event. The value must be one of these defined in this class: -
getAction
public final int getAction()- Returns:
- Returns the action of current event. The value could be one of these defined in this class:
-
setLocation
Sets the location of the text. -
getLocation
- Returns:
- Returns the location of the text.
-
setTextPosition
public final void setTextPosition(int iTextPosition) -
getTextPosition
public final int getTextPosition() -
updateFrom
Updates the event by given LabelBlock object. -
copy
- Overrides:
copy
in classPrimitiveRenderEvent
- Returns:
- A copy of this primitive rendering instruction implemented by subclasses
-
fill
Description copied from class:PrimitiveRenderEvent
Causes this instruction to 'fill' itself on the device renderer- Overrides:
fill
in classPrimitiveRenderEvent
- Throws:
ChartException
-
draw
Description copied from class:PrimitiveRenderEvent
Causes this instruction to 'draw' itself on the device renderer- Overrides:
draw
in classPrimitiveRenderEvent
- Throws:
ChartException
-
reset
public void reset()Description copied from class:ChartEvent
Resets the inner state of current event. This must be implemented if the object is cached and reused.- Specified by:
reset
in classChartEvent
-