Package docking.widgets.fieldpanel.support

Class Highlight

java.lang.Object
docking.widgets.fieldpanel.support.Highlight
public class Highlight extends Object

  • Constructor Summary

    Constructors
    Change
    Constructor
    Description
    Highlight(int start, int end, Color color)
    Constructs a new Highlight that indicates where to highlight text in the listing fields.

  • Method Summary

    Change
    Modifier and Type
    Method
    Description
    Color
    getColor()
    Returns the color to use as the background highlight color..
    int
    getEnd()
    Returns the ending position (inclusive) of the highlight.
    int
    getStart()
    Returns the starting position of the highlight.
    NEW
    int
    length()
    Returns the number of characters in the match..
    void
    setOffset(int newOffset)
    Sets the offset of this highlights start and end values.
    NEW
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Highlight

      public Highlight(int start, int end, Color color)
      Constructs a new Highlight that indicates where to highlight text in the listing fields.
      Parameters:
      start - the starting character position to highlight
      end - the ending character position (inclusive) to highlight
      color - the color to use for highlighting.

  • Method Details

    • getStart

      public int getStart()
      Returns the starting position of the highlight.
      Returns:
      the starting position of the highlight

    • getEnd

      public int getEnd()
      Returns the ending position (inclusive) of the highlight.
      Returns:
      the ending position (inclusive) of the highlight

    • length NEW

      public int length()
      Returns the number of characters in the match..
      Returns:
      the number of characters in the match.

    • getColor

      public Color getColor()
      Returns the color to use as the background highlight color..
      Returns:
      the color to use as the background highlight color.

    • setOffset

      public void setOffset(int newOffset)
      Sets the offset of this highlights start and end values. The effect of the offset is that calls to getStart() and getEnd() will return their values with the offset added.

      This useful when highlights are using offsets for widgets that embedded inside of composite containers. the parent container turn these relative values into absolute values that work when all sub-parts are combined.

      Parameters:
      newOffset - The new offset into this highlight.

    • toString NEW

      public String toString()
      Overrides:
      toString in class Object