org.eclipse.birt.chart.event
Class TextRenderEvent

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

public class TextRenderEvent
extends PrimitiveRenderEvent

TextRenderEvent

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)
           
 
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 setAction(int iAction)
           
 void setBlockAlignment(TextAlignment taBlock)
           
 void setBlockBounds(Bounds boBlock)
           
 void setLabel(Label la)
           
 void setLocation(Location lo)
           
 void setTextPosition(int iTextPosition)
           
 java.lang.String updateFrom(LabelBlock lb, double dScale, RunTimeContext rtc)
           
 
Methods inherited from class org.eclipse.birt.chart.event.PrimitiveRenderEvent
compareRegular, compareTo, compareTransposed, getBounds, getDepth, reset, setDepth, 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)
Parameters:
oSource -
Method Detail

setBlockBounds

public final void setBlockBounds(Bounds boBlock)
Parameters:
boBlock -

getBlockBounds

public final Bounds getBlockBounds()
Returns:

setLabel

public final void setLabel(Label la)
Parameters:
la -

getLabel

public final Label getLabel()
Returns:

setBlockAlignment

public final void setBlockAlignment(TextAlignment taBlock)
Parameters:
taBlock -

getBlockAlignment

public final TextAlignment getBlockAlignment()
Returns:

setAction

public final void setAction(int iAction)
Parameters:
iAction -

getAction

public final int getAction()
Returns:

setLocation

public final void setLocation(Location lo)
Parameters:
lo -

getLocation

public final Location getLocation()
Returns:

setTextPosition

public final void setTextPosition(int iTextPosition)
Parameters:
iTextPosition -

getTextPosition

public final int getTextPosition()
Returns:

updateFrom

public final java.lang.String updateFrom(LabelBlock lb,
                                         double dScale,
                                         RunTimeContext rtc)

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
Parameters:
idr -
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
Parameters:
idr -
Throws:
ChartException


Copyright © 2005 Actuate Corp. All rights reserved.