org.eclipse.birt.chart.event
Class TextRenderEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.eclipse.birt.chart.event.ChartEvent
          extended by org.eclipse.birt.chart.event.PrimitiveRenderEvent
              extended by org.eclipse.birt.chart.event.TextRenderEvent
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable
Direct Known Subclasses:
Text3DRenderEvent

public class TextRenderEvent
extends PrimitiveRenderEvent

A rendering event type for rendering text object.

See Also:
Serialized Form

Field Summary
static int ABOVE
          A constant used with the 'TextPosition' attribute.
static int BELOW
          A constant used with the 'TextPosition' attribute.
static int LEFT
          A constant used with the 'TextPosition' attribute.
static int RENDER_SHADOW_AT_LOCATION
          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 set
static int RENDER_TEXT_AT_LOCATION
          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 set
static int RENDER_TEXT_IN_BLOCK
          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 set
static int RIGHT
          A constant used with the 'TextPosition' attribute.
static int UNDEFINED
          An undefined action that will result in an error
 
Fields inherited from class org.eclipse.birt.chart.event.PrimitiveRenderEvent
DRAW, FILL, iObjIndex
 
Constructor Summary
TextRenderEvent(java.lang.Object oSource)
          The constructor.
 
Method Summary
 PrimitiveRenderEvent copy()
           
 void draw(IDeviceRenderer idr)
          Causes this instruction to 'draw' itself on the device renderer
 void fill(IDeviceRenderer idr)
          Causes this instruction to 'fill' itself on the device renderer
 int getAction()
           
 TextAlignment getBlockAlignment()
           
 Bounds getBlockBounds()
           
 Label getLabel()
           
 Location getLocation()
           
 int getTextPosition()
           
 void reset()
          Resets the inner state of current event.
 void setAction(int iAction)
          Sets the action of current event.
 void setBlockAlignment(TextAlignment taBlock)
          Sets the block alignment of the text.
 void setBlockBounds(Bounds boBlock)
          Sets the block bounds of the text.
 void setLabel(Label la)
          Sets the label of the text.
 void setLocation(Location lo)
          Sets the location of the text.
 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
 void setTextPosition(int iTextPosition)
          Sets the position of the text.
 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UNDEFINED

public static final int UNDEFINED
An undefined action that will result in an error

See Also:
Constant Field Values

RENDER_SHADOW_AT_LOCATION

public static final int RENDER_SHADOW_AT_LOCATION
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 set

See Also:
Constant Field Values

RENDER_TEXT_AT_LOCATION

public static final int RENDER_TEXT_AT_LOCATION
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 set

See Also:
Constant Field Values

RENDER_TEXT_IN_BLOCK

public static final int RENDER_TEXT_IN_BLOCK
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 set

See Also:
Constant Field Values

LEFT

public static final int LEFT
A constant used with the 'TextPosition' attribute. This indicates that the text is positioned to the left of the reference point 'Location'

See Also:
Constant Field Values

RIGHT

public static final int RIGHT
A constant used with the 'TextPosition' attribute. This indicates that the text is positioned to the right of the reference point 'Location'

See Also:
Constant Field Values

ABOVE

public static final int ABOVE
A constant used with the 'TextPosition' attribute. This indicates that the text is positioned above the reference point 'Location'

See Also:
Constant Field Values

BELOW

public static final int BELOW
A constant used with the 'TextPosition' attribute. This indicates that the text is positioned below the reference point 'Location'

See Also:
Constant Field Values
Constructor Detail

TextRenderEvent

public TextRenderEvent(java.lang.Object oSource)
The constructor.

Method Detail

setBlockBounds

public final void setBlockBounds(Bounds boBlock)
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

public final Bounds getBlockBounds()
Returns:
Returns the block bounds of the text.

setLabel

public final void setLabel(Label la)
Sets the label of the text.


getLabel

public final Label getLabel()
Overrides:
getLabel in class PrimitiveRenderEvent
Returns:
Returns the label of the text.

setBlockAlignment

public final void setBlockAlignment(TextAlignment taBlock)
Sets the block alignment of the text.


getBlockAlignment

public final TextAlignment 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

public final void setLocation(Location lo)
Sets the location of the text.


getLocation

public final Location getLocation()
Returns:
Returns the location of the text.

setTextPosition

public final void setTextPosition(int iTextPosition)
Sets the position of the text. The value must be on of these defined in this class:


getTextPosition

public final int getTextPosition()
Returns:
Returns the position of the text. The value could be on of these defined in this class:

updateFrom

public final void updateFrom(LabelBlock lb,
                             double dScale,
                             RunTimeContext rtc)
Updates the event by given LabelBlock object.


copy

public PrimitiveRenderEvent copy()
Overrides:
copy in class PrimitiveRenderEvent
Returns:
A copy of this primitive rendering instruction implemented by subclasses

fill

public void fill(IDeviceRenderer idr)
          throws ChartException
Description copied from class: PrimitiveRenderEvent
Causes this instruction to 'fill' itself on the device renderer

Overrides:
fill in class PrimitiveRenderEvent
Throws:
ChartException

draw

public final void draw(IDeviceRenderer idr)
                throws ChartException
Description copied from class: PrimitiveRenderEvent
Causes this instruction to 'draw' itself on the device renderer

Overrides:
draw in class PrimitiveRenderEvent
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 class ChartEvent


Copyright © 2005-2008 Actuate Corp. All rights reserved.