com.luciad.lucy.addons.print

LuciadLightspeedClass TLcyPrintContext

java.lang.Object

com.luciad.lucy.addons.print.ALcyPrintContext<ILcdGXYView>

com.luciad.lucy.addons.print.TLcyPrintContext

All Implemented Interfaces:

ILcdChangeSource

public class TLcyPrintContext
extends ALcyPrintContext<ILcdGXYView>

A TLcyPrintContext represents all that is needed to print, preview, modify, ... a component which can be printed to one or more pages.

The method getGXYViewPrintableComponent() returns the TLcyPrintableMapComponent corresponding to the page layout and its content. This is the full component containing the main map component and all extra elements as eg. the header text, the scale icon,...

Instances of this object are created internally in the print add-on. They are for example used as a parameter in the methods of TLcyPrintPreviewFactory.

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose this print context.
TLcyGXYViewPrintableComponent	getGXYViewPrintableComponent() Get the TLcyGXYViewPrintableComponent that represents the content of the pages.
int	getPageColumnCount() Returns the used column count.
int	getPageRowCount() Returns the used row count.
Printable	getPrintable() Returns the Printable that prints the view.
ILcdBounds	getPrintArea() Returns the used printing area.
void	invalidate() Invalidates the state of this ALcyPrintContext.

Methods inherited from class com.luciad.lucy.addons.print.ALcyPrintContext

addChangeListener, firePrintableComponentChangeEvent, getProperties, getView, removeChangeListener

Methods inherited from class java.lang.Object

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

Method Detail

dispose

public void dispose()

Description copied from class: ALcyPrintContext

Dispose this print context.

Specified by:

dispose in class ALcyPrintContext<ILcdGXYView>

getGXYViewPrintableComponent

public TLcyGXYViewPrintableComponent getGXYViewPrintableComponent()

Get the TLcyGXYViewPrintableComponent that represents the content of the pages.

Returns:

the content of the pages.

getPrintArea

public ILcdBounds getPrintArea()

Returns the used printing area.

Returns:

the used printing area.

invalidate

public void invalidate()

Description copied from class: ALcyPrintContext

Invalidates the state of this ALcyPrintContext. It can for example be used to refresh the print preview.

Specified by:

invalidate in class ALcyPrintContext<ILcdGXYView>

getPrintable

public Printable getPrintable()

Description copied from class: ALcyPrintContext

Returns the Printable that prints the view.

Specified by:

getPrintable in class ALcyPrintContext<ILcdGXYView>

Returns:

the Printable that prints the view.

getPageColumnCount

public int getPageColumnCount()

Returns the used column count.

Returns:

the used column count.

getPageRowCount

public int getPageRowCount()

Returns the used row count.

Returns:

the used row count.