org.eclipse.nebula.paperclips.core

Class AlignPrint

java.lang.Object

org.eclipse.nebula.paperclips.core.AlignPrint

All Implemented Interfaces:

Print

public class AlignPrint
extends java.lang.Object
implements Print

A wrapper print that aligns its target vertically and/or horizontally. An AlignPrint is vertically greedy when the vertical alignment is SWT.CENTER or SWT.BOTTOM, and horizontally greedy when the horizontal alignment is SWT.CENTER and SWT.RIGHT.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	hAlign
(package private) Print	target
(package private) int	vAlign

Constructor Summary

Constructors

Constructor and Description
AlignPrint(Print target, int hAlign, int vAlign) Constructs a new AlignPrint.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
org.eclipse.swt.graphics.Point	getAlignment() Returns a Point with the x and y fields set to the horizontal and vertical alignment, respectively.
Print	getTarget() Returns the wrapped print being aligned
int	hashCode()
PrintIterator	iterator(org.eclipse.swt.graphics.Device device, org.eclipse.swt.graphics.GC gc) Returns a PrintIterator for laying out the contents of this Print.

Methods inherited from class java.lang.Object

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

Field Detail

target

final Print target

hAlign

final int hAlign

vAlign

final int vAlign

Constructor Detail

AlignPrint

public AlignPrint(Print target,
                  int hAlign,
                  int vAlign)

Constructs a new AlignPrint.

Parameters:

target - the print being aligned.

hAlign - the horizontal alignment. One of SWT.LEFT, SWT.CENTER, SWT.RIGHT, or SWT.DEFAULT.

vAlign - the vertical alignment. One of SWT.TOP, SWT.CENTER, SWT.BOTTOM, or SWT.DEFAULT.

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

getTarget

public Print getTarget()

Returns the wrapped print being aligned

Returns:

the wrapped print being aligned

getAlignment

public org.eclipse.swt.graphics.Point getAlignment()

Returns a Point with the x and y fields set to the horizontal and vertical alignment, respectively.

Returns:

a Point with the x and y fields set to the horizontal and vertical alignment, respectively.

iterator

public PrintIterator iterator(org.eclipse.swt.graphics.Device device,
                              org.eclipse.swt.graphics.GC gc)

Description copied from interface: Print

Returns a PrintIterator for laying out the contents of this Print. The iterator uses a snapshot of the print at the time this method is invoked, so subsequent changes to the Print will not affect the output of the iterator.

Specified by:

iterator in interface Print

Parameters:

device - the graphics device this Print will be drawn onto.

gc - the graphics context to be used for calculating layout and drawing the Print's contents.

Returns:

a PrintIterator for laying out the contents of this Print.