Package org.eclipse.nebula.paperclips.core.border

Class AbstractBorderPainter

java.lang.Object
org.eclipse.nebula.paperclips.core.border.AbstractBorderPainter
All Implemented Interfaces:
BorderPainter
Direct Known Subclasses:
GapBorderPainter, LineBorderPainter
public abstract class AbstractBorderPainter
extends java.lang.Object
implements BorderPainter
Abstract implementation of BorderPainter providing implementation of helper methods.

  • Constructor Summary

    Constructors 
    Constructor Description
    AbstractBorderPainter()  

  • Method Summary

    Modifier and Type Method Description
    abstract int getBottom​(boolean open)
    Returns the border inset, in pixels, from the bottom.
    int getHeight​(boolean topOpen, boolean bottomOpen)
    Returns the sum of the top and bottom border insets.
    abstract int getLeft()
    Returns the border inset, in pixels, from the left.
    int getMaxHeight()
    Returns the sum of the maximum top and bottom border insets.
    abstract int getRight()
    Returns the border inset, in pixels, from the right.
    abstract int getTop​(boolean open)
    Returns the border inset, in pixels, from the top.
    int getWidth()
    Returns the sum of the left and right border insets.
    abstract void paint​(org.eclipse.swt.graphics.GC gc, int x, int y, int width, int height, boolean topOpen, boolean bottomOpen)
    Paints a border around the specified region.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.eclipse.nebula.paperclips.core.border.BorderPainter

    dispose, getOverlap

  • Constructor Details

  • Method Details

    • paint

      public abstract void paint​(org.eclipse.swt.graphics.GC gc, int x, int y, int width, int height, boolean topOpen, boolean bottomOpen)
      Paints a border around the specified region. Depending on the type of border, the top and bottom of may be painted differently depending on the values of topOpen and bottomOpen.
      Specified by:
      paint in interface BorderPainter
      Parameters:
      gc - The graphics context to paint on.
      x - The x coordinate of the top left corner of the border.
      y - The y coordinate of the top left corner of the border.
      width - The width of the border to paint
      height - The height of the border to paint
      topOpen - If true, the top border should be drawn "open," to indicate that this is the continuation of a border in a previous iteration. If false, the border should be drawn "closed" to indicate that this is the first iteration on the BorderPrint's target.
      bottomOpen - If true, the bottom border should be drawn "open," to indicate that the BorderPrint's target was not consumed in this iteration. If false, the bottom border should be drawn "closed," to indicate that the BorderPrint's target completed during this iteration.

    • getLeft

      public abstract int getLeft()
      Returns the border inset, in pixels, from the left.
      Specified by:
      getLeft in interface BorderPainter
      Returns:
      the border inset, in pixels, from the left.

    • getRight

      public abstract int getRight()
      Returns the border inset, in pixels, from the right.
      Specified by:
      getRight in interface BorderPainter
      Returns:
      the border inset, in pixels, from the right.

    • getWidth

      public final int getWidth()
      Returns the sum of the left and right border insets.
      Specified by:
      getWidth in interface BorderPainter
      Returns:
      the sum of the left and right border insets.

    • getTop

      public abstract int getTop​(boolean open)
      Returns the border inset, in pixels, from the top.
      Specified by:
      getTop in interface BorderPainter
      Parameters:
      open - If true, the inset of an open border will be returned. If false, the inset of a closed border will be returned.
      Returns:
      the border inset, in pixels, from the top.

    • getBottom

      public abstract int getBottom​(boolean open)
      Returns the border inset, in pixels, from the bottom.
      Specified by:
      getBottom in interface BorderPainter
      Parameters:
      open - If true, the inset of an open border will be returned. If false, the inset of a closed border will be returned.
      Returns:
      the border inset, in pixels, from the bottom.

    • getHeight

      public final int getHeight​(boolean topOpen, boolean bottomOpen)
      Returns the sum of the top and bottom border insets.
      Specified by:
      getHeight in interface BorderPainter
      Parameters:
      topOpen - If true, the inset of an open border will be returned. If false, the inset of a closed border will be returned.
      bottomOpen - If true, the inset of an open border will be returned. If false, the inset of a closed border will be returned.
      Returns:
      the sum of the top and bottom border insets.

    • getMaxHeight

      public final int getMaxHeight()
      Returns the sum of the maximum top and bottom border insets.
      Specified by:
      getMaxHeight in interface BorderPainter
      Returns:
      the sum of the maximum top and bottom border insets.