Class ClippingEvent

  • All Implemented Interfaces:
    java.io.Serializable

    public class ClippingEvent
    extends java.util.EventObject
    An object of this type is passed to a clipping listener on the event of a clip while rendering an element. This object contains three pieces of information:
    • A reference to the element which is being clipped.
    • The actual value of the element which is being clipped.
    • The text string of what is being displayed after the clip.
    Since:
    6.1
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class java.util.EventObject

        source
    • Constructor Summary

      Constructors 
      Constructor Description
      ClippingEvent​(java.lang.Object source)
      FOR INTERNAL USE ONLY
      ClippingEvent​(java.lang.Object source, java.lang.Object value, java.lang.String valueAfter)
      FOR INTERNAL USE ONLY
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getClippedResult()
      Returns the displayed text value after clipping.
      Element getElement()
      Returns the element on which the clipping occurred.
      java.lang.Object getValueBeforeClip()
      Returns the actual value which will be clipped or truncated.
      • Methods inherited from class java.util.EventObject

        getSource, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ClippingEvent

        public ClippingEvent​(java.lang.Object source,
                             java.lang.Object value,
                             java.lang.String valueAfter)
        FOR INTERNAL USE ONLY
        Since:
        6.1
      • ClippingEvent

        public ClippingEvent​(java.lang.Object source)
        FOR INTERNAL USE ONLY
        Since:
        6.1
    • Method Detail

      • getElement

        public Element getElement()
        Returns the element on which the clipping occurred.
        Returns:
        An Element on which the clipping occurred.
        Since:
        6.1
      • getValueBeforeClip

        public java.lang.Object getValueBeforeClip()
        Returns the actual value which will be clipped or truncated.
        Returns:
        The actual value (Long, Double, String, etc...).
        Since:
        6.1
      • getClippedResult

        public java.lang.String getClippedResult()
        Returns the displayed text value after clipping.
        Returns:
        The clipped value as a string object.
        Since:
        6.1