ilog.views.util.print

Class IlvPrintableLabel

java.lang.Object

ilog.views.util.print.IlvPrintableObject

ilog.views.util.print.IlvPrintableLabel

All Implemented Interfaces:

Printable

public class IlvPrintableLabel
extends IlvPrintableObject

This class is designed to print a label on a printable page.

Since:

JViews 5.5

See Also:

IlvPage

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
IlvPrintableLabel(String label, Font font, Color color, IlvUnit.Rectangle area) Creates a IlvPrintableLabel with the specified label, font, color, and position.
IlvPrintableLabel(String label, IlvUnit.Rectangle area) Creates a IlvPrintableLabel with the specified label and position.

Method Summary

Modifier and Type	Method and Description
Color	getColor() Returns the color used to print the label.
Font	getFont() Returns the font used to print the label.
String	getLabel() Returns the label to be printed.
IlvUnit.Rectangle	getPrintableArea() Returns the area, in page coordinates, defining where the label should be printed.
int	print(Graphics dst, PageFormat format, int pageIndex) Implements the java.awt.print.Printable.print method.
void	setColor(Color color) Sets the color used to print the label.
void	setFont(Font font) Sets the font used to print the label.
void	setLabel(String label) Sets the label to be printed.
void	setPrintableArea(IlvUnit.Rectangle area) Sets the area, in page coordinates, defining where the label should be printed.

Methods inherited from class ilog.views.util.print.IlvPrintableObject

getPage

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPrintableLabel

public IlvPrintableLabel(String label,
                         Font font,
                         Color color,
                         IlvUnit.Rectangle area)

Creates a IlvPrintableLabel with the specified label, font, color, and position.

Parameters:

label - The label to be printed.

font - The font used to print the label.

color - The color used to print the label.

area - The position where the label is printed.

IlvPrintableLabel

public IlvPrintableLabel(String label,
                         IlvUnit.Rectangle area)

Creates a IlvPrintableLabel with the specified label and position. The font is created by calling Font.decode(null) and the color is black.

Parameters:

label - The label to be printed.

area - The position where the label is printed.

Method Detail

getLabel

public String getLabel()

Returns the label to be printed.

Returns:

The label to be printed.

See Also:

setLabel(java.lang.String)

setLabel

public void setLabel(String label)

Sets the label to be printed.

Parameters:

label - The label to be printed.

See Also:

getLabel()

getColor

public Color getColor()

Returns the color used to print the label.

Returns:

The color used to print the label.

See Also:

setColor(java.awt.Color)

setColor

public void setColor(Color color)

Sets the color used to print the label.

Parameters:

color - The color used to print the label.

See Also:

getColor()

getFont

public Font getFont()

Returns the font used to print the label.

Returns:

The font used to print the label.

See Also:

setFont(java.awt.Font)

setFont

public void setFont(Font font)

Sets the font used to print the label.

Parameters:

font - The font used to print the label.

See Also:

getFont()

getPrintableArea

public IlvUnit.Rectangle getPrintableArea()

Returns the area, in page coordinates, defining where the label should be printed.

Returns:

The print area, defined in page coordinates.

See Also:

setPrintableArea(ilog.views.util.print.IlvUnit.Rectangle)

setPrintableArea

public void setPrintableArea(IlvUnit.Rectangle area)

Sets the area, in page coordinates, defining where the label should be printed.

Parameters:

area - The print area, defined in page coordinates.

See Also:

getPrintableArea()

print

public int print(Graphics dst,
                 PageFormat format,
                 int pageIndex)
          throws PrinterException

Implements the java.awt.print.Printable.print method. This method is called to print the label.

Parameters:

dst - The output device, which must be a Graphics2D object.

format - The format of the page.

pageIndex - The index of the page.

Throws:

PrinterException