com.luciad.lucy.addons.print

LuciadLightspeedClass ALcyPrintContext<V extends ILcdView>

java.lang.Object

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

All Implemented Interfaces:

ILcdChangeSource

Direct Known Subclasses:

TLcyLspPrintContext, TLcyPrintContext

public abstract class ALcyPrintContext<V extends ILcdView>
extends Object
implements ILcdChangeSource

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

Instances of this object are created internally in the print add-ons.

Since:

2013.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ALcyPrintContext(V aView, TLcyProperties aProperties) Creates a new print context for the given view and properties. Instances of this object should only be created internally by the print add-ons.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ILcdChangeListener aListener) Registers the given listener so it will receive change events from this source.
abstract void	dispose() Dispose this print context.
protected void	firePrintableComponentChangeEvent(TLcdChangeEvent aEvent) Fires a change event to notify that the printable component has changed.
abstract Printable	getPrintable() Returns the Printable that prints the view.
TLcyProperties	getProperties() Get the properties object for this printable component.
V	getView() Returns the view that represents the content of the printable.
abstract void	invalidate() Invalidates the state of this ALcyPrintContext.
void	removeChangeListener(ILcdChangeListener aListener) Removes the specified listener so it is no longer notified.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcyPrintContext

protected ALcyPrintContext(V aView,
                           TLcyProperties aProperties)

Creates a new print context for the given view and properties.
Instances of this object should only be created internally by the print add-ons.

Parameters:

aView - the view

aProperties - the properties.

Method Detail

getView

public V getView()

Returns the view that represents the content of the printable.

Returns:

the view.

dispose

public abstract void dispose()

Dispose this print context.

getProperties

public TLcyProperties getProperties()

Get the properties object for this printable component. The keys of these properties are the various constants that end in KEY of TLcyPrintAddOn.

Returns:

the properties object for this printable component.

addChangeListener

public void addChangeListener(ILcdChangeListener aListener)

Description copied from interface: ILcdChangeSource

Registers the given listener so it will receive change events from this source.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakChangeListener instance as change listener.

Specified by:

addChangeListener in interface ILcdChangeSource

Parameters:

aListener - The listener to be notified when a change has happened.

See Also:

ILcdChangeSource.removeChangeListener(ILcdChangeListener), ALcdWeakChangeListener

removeChangeListener

public void removeChangeListener(ILcdChangeListener aListener)

Description copied from interface: ILcdChangeSource

Removes the specified listener so it is no longer notified.

Specified by:

removeChangeListener in interface ILcdChangeSource

Parameters:

aListener - The listener to remove.

firePrintableComponentChangeEvent

protected final void firePrintableComponentChangeEvent(TLcdChangeEvent aEvent)

Fires a change event to notify that the printable component has changed.

Parameters:

aEvent - a change event

getPrintable

public abstract Printable getPrintable()

Returns the Printable that prints the view.

Returns:

the Printable that prints the view.

invalidate

public abstract void invalidate()

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