Class TextRenderEvent

All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
Text3DRenderEvent

public class TextRenderEvent extends PrimitiveRenderEvent
A rendering event type for rendering text object.
See Also:
  • Field Details

    • UNDEFINED

      public static final int UNDEFINED
      An undefined action that will result in an error
      See Also:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
  • Constructor Details

    • TextRenderEvent

      public TextRenderEvent(Object oSource)
      The constructor.
  • Method Details

    • 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