Package net.sf.paperclips

Class GridColumn

  • public class GridColumn
extends java.lang.Object
    Describes the properties of a column in a GridPrint.
    Author:
    Matthew Hall

    • Field Summary

      Fields 
      Modifier and Type Field Description
      int align
      The default alignment for Prints in this column.
      static int DEFAULT_ALIGN
      The default alignment used when alignment is not specified.
      static int DEFAULT_SIZE
      The default size used when size is not specified.
      static int DEFAULT_WEIGHT
      The default weight used when weight is not specified.
      int size
      The size property for this GridColumn.
      int weight
      The weight of this column.

    • Constructor Summary

      Constructors 
      Constructor Description
      GridColumn​(int align, int size, int weight)
      Constructs a GridColumn.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int hashCode()  
      static GridColumn parse​(java.lang.String spec)
      Parses the given column spec and returns a GridColumn matching that spec.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_ALIGN

        public static final int DEFAULT_ALIGN
        The default alignment used when alignment is not specified. Value is SWT.LEFT.
        See Also:
        Constant Field Values

      • DEFAULT_SIZE

        public static final int DEFAULT_SIZE
        The default size used when size is not specified. Value is SWT.DEFAULT.
        See Also:
        Constant Field Values

      • DEFAULT_WEIGHT

        public static final int DEFAULT_WEIGHT
        The default weight used when weight is not specified. Value is 0.
        See Also:
        Constant Field Values

      • size

        public final int size
        The size property for this GridColumn. Possible values:
        • GridPrint.PREFERRED - indicates that the column should be as wide as the preferred width of its widest element.
        • SWT.DEFAULT - Similar to GridPrint.PREFERRED, except that the column may shrink down to its minimum width if space is scarce.
        • A value > 0 indicates that the column should be size points wide (72pts = 1").

      • align

        public final int align
        The default alignment for Prints in this column. Possible values are SWT.LEFT, SWT.CENTER, SWT.RIGHT, or SWT.DEFAULT. Note that alignment affects the placement of PrintPieces within the grid's cell--the alignment elements of the PrintPiece themselves are not affected. Thus, in order to achieve the desired effect, a Print having an alignment property should be set to the same alignment as the grid cell it is added to. For example, a TextPrint in a right-aligned grid cell should be set to right alignment as well.

        Cells that span multiple columns use the alignment of the left-most cell in the cell span.

      • weight

        public final int weight
        The weight of this column. If the available print space is wider than the grid's preferred width, this field determines how much of that extra space should be given to this column. A larger weight causes the column to receive more of the extra width. A value of 0 indicates that the column should not be given any excess width.

    • Constructor Detail

      • GridColumn

        public GridColumn​(int align,
                  int size,
                  int weight)
        Constructs a GridColumn.
        Parameters:
        align - The default alignment for Prints in this column.
        size - The size this column should be given.
        weight - The weight this column should be given.

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • parse

        public static GridColumn parse​(java.lang.String spec)
        Parses the given column spec and returns a GridColumn matching that spec.

        Format: 

          [align:]size[:grow]
  
  align  = L | LEFT |
           C | CENTER |
           R | RIGHT
  size   = P | PREF | PREFERRED |
           D | DEF | DEFAULT |
           (Positive number)[PT|IN|INCH|CM|MM]
  weight = N | NONE |
           G | GROW | G(#) | GROW(#)
        The default alignment is LEFT. The weight argument expresses the weight property: NONE indicates a weight of 0; GROW indicates a weight of 1; and GROW(3) indicates a weight of 3. The default weight (if weight is omitted) is 0.

        Examples: 

         LEFT:DEFAULT:GROW // left-aligned, default size, weight=1
  R:72PT:N          // light-aligned, 72 points (1") wide, weight=0
  right:72          // identical to previous line
  c:pref:none       // center-aligned, preferred size, weight=0
  p                 // left-aligned (default), preferred size, weight=0
  r:2inch           // right-aligned, 2 inches (50.8mm)
  r:50.8mm          // right-aligned, 50.8 mm (2")
        Parameters:
        spec - the column spec that will be parsed.
        Returns:
        a GridColumn matching the column spec.
        See Also:
        align, size, weight