public class TLcyPrintAddOn extends ALcyAddOn
ALcyPrintableComponentFactory
. The factory instance can be explicitly set by using
setPrintableComponentFactory
or the class can be set by using the configuration file.
If no factory is set, a default factory will be used.
The content of the print preview dialog is created by a ALcyPrintPreviewFactory
. The
factory instance can be explicitly set by using setPrintPreviewFactory
or the class
can be set by using the configuration file. If no factory is set, a default factory will be used.
The content of the editor used to modify a selected print area, is created by a
ILcyObjectCustomizerFactory
. The factory instance can be explicitly set using
setPrintAreaCustomizerFactory
or the class can be set
using the configuration file. It is recommended to subclass TLcyPrintAreaCustomizerFactory
for this purpose. If no factory is set, a default factory will be used.
A TLcyProperties
object is created for every map component. It contains the current
stored values of the properties used in the print addon. Initially all configured properties from the
configuration file are added. Afterwards, the object is updated each time a property has changed eg.
the page orientation, the visibility of the footer text,... The keys that can be used to retrieve
information from or set information to the properties (using for example get
)
are the constants of this class ending in KEY
, e.g., PAGE_FORMAT_KEY
,
HEADER_TEXT_SELECTED_KEY
, ... The value that can be expected for every key is documented
in the key constant itself, the default value is specified in constants ending in VALUE_DEFAULT
.
createPageDecorator
, or to add printed pages by overriding
createPrintPageable
. For more
information, see the javadoc of these methods.
Note: If the new functionality is not desired, the behavior prior to 6.1 can be used by
setting the configuration property "TLcyPrintAddOn.usePriorTo6.1" to true. In this case, no
multipage printing is possible and only the 'Print...' menu item is added. Modifier and Type | Field and Description |
---|---|
static String |
BACKGROUND_COLOR_MAP_KEY
Property name for the background color of the maps in the configuration file.
|
static String |
BACKGROUND_COLOR_MAP_OVERVIEW_KEY
Property name for the background color of the map overviews in the configuration file.
|
static Color |
BACKGROUND_COLOR_MAP_OVERVIEW_VALUE_DEFAULT
Default value for the property
BACKGROUND_COLOR_MAP_OVERVIEW_KEY . |
static Color |
BACKGROUND_COLOR_MAP_VALUE_DEFAULT
Default value for the property
BACKGROUND_COLOR_MAP_KEY . |
static String |
CLASSIFICATION_COMBO_BOX_VISIBLE_KEY
Property name which represents the visibility of the 'classification combo box'.
|
static boolean |
CLASSIFICATION_COMBO_BOX_VISIBLE_VALUE_DEFAULT
Default value for the property
CLASSIFICATION_COMBO_BOX_VISIBLE_KEY |
static String |
CLASSIFICATION_KEY
Property name which represents the selected value of the 'classification combo box'.
|
static String |
CLASSIFICATION_SELECTED_KEY
Property name which represents the value of the 'classification checkbox'.
|
static boolean |
CLASSIFICATION_SELECTED_VALUE_DEFAULT
Default value for the property
CLASSIFICATION_SELECTED_KEY |
static String |
CLASSIFICATION_VISIBLE_KEY
Property name which represents the visibility of the 'classification checkbox'.
|
static boolean |
CLASSIFICATION_VISIBLE_VALUE_DEFAULT
Default value for the property
CLASSIFICATION_VISIBLE_KEY |
static String |
COL_COUNT_SUFFIX
Property suffix for the column count.
|
static int |
COL_COUNT_VALUE_DEFAULT
Default value for the property
COL_COUNT_SUFFIX . |
static String |
CROP_MARKS_SELECTED_KEY
Property name which represents the value of the 'crop marks' checkbox.
|
static boolean |
CROP_MARKS_SELECTED_VALUE_DEFAULT
Default value for the property
CROP_MARKS_SELECTED_KEY . |
static String |
CROP_MARKS_VISIBLE_KEY
Property name which represents the visibility of the 'crop marks' checkbox.
|
static boolean |
CROP_MARKS_VISIBLE_VALUE_DEFAULT
Default value for the property
CROP_MARKS_VISIBLE_KEY . |
static String |
FOOTER_TEXT_KEY
Property name which represents the html file to use as 'footer text'.
|
static String |
FOOTER_TEXT_SELECTED_KEY
Property name which represents the value of the 'footer text' checkbox.
|
static boolean |
FOOTER_TEXT_SELECTED_VALUE_DEFAULT
Default value for the property
FOOTER_TEXT_SELECTED_KEY . |
static String |
FOOTER_TEXT_VALUE_DEFAULT
Default value for the property
FOOTER_TEXT_KEY . |
static String |
FOOTER_TEXT_VISIBLE_KEY
Property name which represents the visibility of the 'footer text' checkbox.
|
static boolean |
FOOTER_TEXT_VISIBLE_VALUE_DEFAULT
Default value for the property
FOOTER_TEXT_VISIBLE_KEY . |
static String |
HEADER_TEXT_KEY
Property name which represents the html file to use as 'header text'.
|
static String |
HEADER_TEXT_SELECTED_KEY
Property name which represents the value of the 'header text' checkbox.
|
static boolean |
HEADER_TEXT_SELECTED_VALUE_DEFAULT
Default value for the property
HEADER_TEXT_SELECTED_KEY . |
static String |
HEADER_TEXT_VALUE_DEFAULT
Default value for the property
HEADER_TEXT_KEY . |
static String |
HEADER_TEXT_VISIBLE_KEY
Property name which represents the visibility of the 'header text' checkbox.
|
static boolean |
HEADER_TEXT_VISIBLE_VALUE_DEFAULT
Default value for the property
HEADER_TEXT_VISIBLE_KEY . |
static String |
INCLUDES_COVERED_AREA_SUFFIX
Deprecated.
This property has been deprecated. It is handled automatically, based on the value
of the
PRINTING_AREA_CHOICE_KEY property
(PRINTING_AREA_CHOICE_VALUE_PRINT_AREA -> true, otherwise false). |
static boolean |
INCLUDES_COVERED_AREA_VALUE_DEFAULT
Deprecated.
This property has been deprecated. See
INCLUDES_COVERED_AREA_SUFFIX . |
static String |
LEGEND_SELECTED_KEY
Property name which represents the value of the 'legend' checkbox.
|
static boolean |
LEGEND_SELECTED_VALUE_DEFAULT
Default value for the property
LEGEND_SELECTED_KEY . |
static String |
LEGEND_VISIBLE_KEY
Property name which represents the visibility of the 'legend' checkbox.
|
static boolean |
LEGEND_VISIBLE_VALUE_DEFAULT
Default value for the property
LEGEND_VISIBLE_KEY . |
static String |
MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_KEY
Property name which represents the value of the 'header text field'.
|
static boolean |
MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_VALUE_DEFAULT
Default value for the property
MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_KEY |
static String |
MODIFIABLE_HEADER_TEXT_KEY
Property name which controls the text to use as 'header text'.
|
static String |
MODIFIABLE_HEADER_TEXT_SELECTED_KEY
Property name which represents the value of the 'header text' checkbox.
|
static boolean |
MODIFIABLE_HEADER_TEXT_SELECTED_VALUE_DEFAULT
Default value for the property
MODIFIABLE_HEADER_TEXT_SELECTED_KEY |
static String |
MODIFIABLE_HEADER_TEXT_VALUE_DEFAULT
Default value for the property
MODIFIABLE_HEADER_TEXT_KEY |
static String |
MODIFIABLE_HEADER_TEXT_VISIBLE_KEY
Property name which represents the visibility of the 'header text' checkbox.
|
static boolean |
MODIFIABLE_HEADER_TEXT_VISIBLE_VALUE_DEFAULT
Default value for the property
MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_KEY |
static String |
ORIENTATION_CHOICE_KEY
Property name for the chosen page orientation.
|
static String |
ORIENTATION_CHOICE_VALUE_DEFAULT
Default value for the property
ORIENTATION_CHOICE_KEY . |
static String |
ORIENTATION_CHOICE_VALUE_LANDSCAPE
Custom orientation 'landscape' for the property
ORIENTATION_CHOICE_KEY . |
static String |
ORIENTATION_CHOICE_VALUE_PORTRAIT
Custom orientation 'portrait' for the property
ORIENTATION_CHOICE_KEY . |
static String |
OVERVIEW_ENABLED_KEY
Property name which represents the enabled state of the 'overview' checkbox.
|
static boolean |
OVERVIEW_ENABLED_VALUE_DEFAULT
Default value for the property
OVERVIEW_ENABLED_KEY . |
static String |
OVERVIEW_SELECTED_KEY
Property name which represents the value of the 'overview' checkbox.
|
static boolean |
OVERVIEW_SELECTED_VALUE_DEFAULT
Default value for the property
OVERVIEW_SELECTED_KEY . |
static String |
OVERVIEW_VISIBLE_KEY
Property name which represents the visibility of the 'overview' checkbox.
|
static boolean |
OVERVIEW_VISIBLE_VALUE_DEFAULT
Default value for the property
OVERVIEW_VISIBLE_KEY . |
static String |
PAGE_FORMAT_KEY
Property name for the chosen page format.
|
static String |
POSITION_MARKS_SELECTED_KEY
Property name which represents the value of the 'position marks' checkbox.
|
static boolean |
POSITION_MARKS_SELECTED_VALUE_DEFAULT
Default value for the property
POSITION_MARKS_SELECTED_KEY . |
static String |
POSITION_MARKS_VISIBLE_KEY
Property name which represents the visibility of the 'position marks' checkbox.
|
static boolean |
POSITION_MARKS_VISIBLE_VALUE_DEFAULT
Default value for the property
POSITION_MARKS_VISIBLE_KEY . |
static String |
PREVIEW_PAGES_LIMIT_KEY
Property name for the pages limit of the print preview.
|
static int |
PREVIEW_PAGES_LIMIT_VALUE_DEFAULT
Default value for the property
PREVIEW_PAGES_LIMIT_KEY |
static String |
PREVIEW_SCALE_ITEMS_KEY
Property name for the print preview scales.
|
static double[] |
PREVIEW_SCALE_ITEMS_VALUE_DEFAULT
Default value for the property
PREVIEW_SCALE_ITEMS_KEY |
static String |
PREVIEW_SCALE_KEY
Property name for the print preview scale.
|
static double |
PREVIEW_SCALE_VALUE_DEFAULT
Default value for the property
PREVIEW_SCALE_KEY |
static String |
PRINT_AREA_SUFFIX
Property suffix which represents the print area to use.
|
static ILcdBounds |
PRINT_AREA_VALUE_DEFAULT
Default value for the property
PRINT_AREA_SUFFIX . |
static TLcyGroupDescriptor |
PRINT_GROUP_DESCRIPTOR |
static String |
PRINT_PAGES_LIMIT_KEY
Property name for the pages limit of the print action.
|
static int |
PRINT_PAGES_LIMIT_VALUE_DEFAULT
Default value for the property
PRINT_PAGES_LIMIT_KEY |
static String |
PRINT_SCALE_ITEMS_KEY
Property that represents an enumeration of the possible print scale values.
|
static double[] |
PRINT_SCALE_ITEMS_VALUE_DEFAULT
Default value for the property
PRINT_SCALE_ITEMS_KEY . |
static String |
PRINT_SCALE_KEY
Property representing the relative size of icons, lines, and text.
|
static String |
PRINT_SCALE_MAXIMUM_KEY
Property name which represents the maximum print scale.
|
static double |
PRINT_SCALE_MAXIMUM_VALUE_DEFAULT
Default value for the property
PRINT_SCALE_MAXIMUM_KEY . |
static String |
PRINT_SCALE_MINIMUM_KEY
Property name which represents the minimum print scale.
|
static double |
PRINT_SCALE_MINIMUM_VALUE_DEFAULT
Default value for the property
PRINT_SCALE_MINIMUM_KEY . |
static double |
PRINT_SCALE_VALUE_DEFAULT
Default value for the property
PRINT_SCALE_KEY , expressed as a percentage (0.95 means 95%). |
static String |
PRINT_SCALE_VISIBLE_KEY
Property name which represents the visibility of the print scale slider.
|
static boolean |
PRINT_SCALE_VISIBLE_VALUE_DEFAULT
Default value for the property
PRINT_SCALE_VISIBLE_KEY . |
static String |
PRINT_SERVICE_KEY
Property name for the chosen print service.
|
static String |
PRINTER_JOB_KEY
Property name for the chosen printer job.
|
static String |
PRINTING_AREA_CHOICE_KEY
Property name representing the printing area to use.
|
static String |
PRINTING_AREA_CHOICE_VALUE_DEFAULT
Default value for the property
PRINTING_AREA_CHOICE_KEY . |
static String |
PRINTING_AREA_CHOICE_VALUE_PRINT_AREA
Custom printing area 'printArea' for the property
PRINTING_AREA_CHOICE_KEY . |
static String |
PRINTING_AREA_CHOICE_VALUE_VIEW_EXTENTS
Custom printing area 'viewExtents' for the property
PRINTING_AREA_CHOICE_KEY . |
static String |
PRINTING_AREA_PREFIX
The property prefix to use for the 'printingArea' properties.
|
static String |
RASTERIZATION_QUALITY_ITEMS_KEY
Property that represents an enumeration of the possible rasterization quality values in dpi.
|
static int[] |
RASTERIZATION_QUALITY_ITEMS_VALUE_DEFAULT
Default value for the property
RASTERIZATION_QUALITY_ITEMS_KEY . |
static String |
RASTERIZATION_QUALITY_KEY
Property name which represents the rasterization quality in dpi.
|
static String |
RASTERIZATION_QUALITY_LABELS_KEY
Property that represents an enumeration fo the labels for the possible rasterization quality values in dpi.
|
static String[] |
RASTERIZATION_QUALITY_LABELS_VALUE_DEFAULT
Default value for the property
RASTERIZATION_QUALITY_LABELS_KEY . |
static String |
RASTERIZATION_QUALITY_MAXIMUM_KEY
Property name which represents the maximum rasterization quality in dpi.
|
static int |
RASTERIZATION_QUALITY_MAXIMUM_VALUE_DEFAULT
Default value for the property
RASTERIZATION_QUALITY_MAXIMUM_KEY . |
static String |
RASTERIZATION_QUALITY_MINIMUM_KEY
Property name which represents the minimum rasterization quality in dpi.
|
static int |
RASTERIZATION_QUALITY_MINIMUM_VALUE_DEFAULT
Default value for the property
RASTERIZATION_QUALITY_MINIMUM_KEY . |
static int |
RASTERIZATION_QUALITY_VALUE_DEFAULT
Default value for the property
RASTERIZATION_QUALITY_KEY . |
static String |
RASTERIZATION_QUALITY_VISIBLE_KEY
Property name which represents the visibility of the rasterization quality slider.
|
static boolean |
RASTERIZATION_QUALITY_VISIBLE_VALUE_DEFAULT
Default value for the property
RASTERIZATION_QUALITY_VISIBLE_KEY . |
static String |
ROW_COUNT_SUFFIX
Property suffix for the row count.
|
static int |
ROW_COUNT_VALUE_DEFAULT
Default value for the property
ROW_COUNT_SUFFIX . |
static String |
SCALE_ICON_SELECTED_KEY
Property name which represents the value of the 'scale icon' checkbox.
|
static boolean |
SCALE_ICON_SELECTED_VALUE_DEFAULT
Default value for the property
SCALE_ICON_SELECTED_KEY . |
static String |
SCALE_ICON_VISIBLE_KEY
Property name which represents the visibility of the 'scale icon' checkbox.
|
static boolean |
SCALE_ICON_VISIBLE_VALUE_DEFAULT
Default value for the property
SCALE_ICON_VISIBLE_KEY . |
static String |
SCALE_OR_PAGES_SUFFIX
Property suffix which represents a chosen calculation type.
|
static String |
SCALE_OR_PAGES_VALUE_DEFAULT
Default value for the property
SCALE_OR_PAGES_SUFFIX . |
static String |
SCALE_OR_PAGES_VALUE_PAGES
Custom 'pages' value for the property
SCALE_OR_PAGES_SUFFIX . |
static String |
SCALE_OR_PAGES_VALUE_SCALE
Custom 'scale' value for the property
SCALE_OR_PAGES_SUFFIX . |
static String |
SCALE_TEXT_SELECTED_KEY
Property name which represents the value of the 'scale indication' checkbox.
|
static boolean |
SCALE_TEXT_SELECTED_VALUE_DEFAULT
Default value for the property
SCALE_TEXT_SELECTED_KEY . |
static String |
SCALE_TEXT_VISIBLE_KEY
Property name which represents the visibility of the 'scale indication' checkbox.
|
static boolean |
SCALE_TEXT_VISIBLE_VALUE_DEFAULT
Default value for the property
SCALE_TEXT_VISIBLE_KEY . |
static String |
SNAP_TO_FULL_PAGES_SELECTED_SUFFIX
Property suffix which represents the value of the 'snap to full pages' checkbox.
|
static boolean |
SNAP_TO_FULL_PAGES_SELECTED_VALUE_DEFAULT
Default value for the property
SNAP_TO_FULL_PAGES_SELECTED_SUFFIX . |
static String |
SNAP_TO_FULL_PAGES_VISIBLE_SUFFIX
Property suffix which represents the visibility of the 'snap to full pages' checkbox.
|
static boolean |
SNAP_TO_FULL_PAGES_VISIBLE_VALUE_DEFAULT
Default value for the property
SNAP_TO_FULL_PAGES_VISIBLE_SUFFIX . |
static String |
SPECIFIC_SCALE_ITEMS_SUFFIX
Property suffix for the paper scales.
|
static double[] |
SPECIFIC_SCALE_ITEMS_VALUE_DEFAULT
Default value for the property
SPECIFIC_SCALE_ITEMS_SUFFIX . |
static String |
SPECIFIC_SCALE_SUFFIX
Property suffix for the paper scale.
|
static double |
SPECIFIC_SCALE_VALUE_DEFAULT
Default value for the property
SPECIFIC_SCALE_SUFFIX . |
static String |
TITLE_TEXT_FIELD_VISIBLE_KEY
Property name which represents the visibility of the 'title text field'.
|
static boolean |
TITLE_TEXT_FIELD_VISIBLE_VALUE_DEFAULT
Default value for the property
TITLE_TEXT_FIELD_VISIBLE_KEY . |
static String |
TITLE_TEXT_KEY
Property name which represents the text to use as 'title text'.
|
static String |
TITLE_TEXT_SELECTED_KEY
Property name which represents the value of the 'title text' checkbox.
|
static boolean |
TITLE_TEXT_SELECTED_VALUE_DEFAULT
Default value for the property
TITLE_TEXT_SELECTED_KEY . |
static String |
TITLE_TEXT_VALUE_DEFAULT
Default value for the property
TITLE_TEXT_KEY . |
static String |
TITLE_TEXT_VISIBLE_KEY
Property name which represents the visibility of the 'title text' checkbox.
|
static boolean |
TITLE_TEXT_VISIBLE_VALUE_DEFAULT
Default value for the property
TITLE_TEXT_VISIBLE_KEY . |
static String |
TRANSPARENCY_HANDLING_KEY
Property name which represents the way to handle transparency.
|
static int |
TRANSPARENCY_HANDLING_VALUE_DEFAULT
Default value for the property
TRANSPARENCY_HANDLING_KEY |
static int |
TRANSPARENCY_HANDLING_VALUE_JAVA_PRINTING
Custom transparency handling for the property
TRANSPARENCY_HANDLING_KEY |
static int |
TRANSPARENCY_HANDLING_VALUE_MEMORY_OPTIMIZED
Custom transparency handling for the property
TRANSPARENCY_HANDLING_KEY |
static int |
TRANSPARENCY_HANDLING_VALUE_VECTOR_OPTIMIZED
Custom transparency handling for the property
TRANSPARENCY_HANDLING_KEY |
Constructor and Description |
---|
TLcyPrintAddOn()
Creates a new print add-on.
|
Modifier and Type | Method and Description |
---|---|
protected TLcyProperties |
createDefaultProperties(ILcyMapComponent aMapComponent)
This method is used by the
getProperties(ILcyMapComponent) method to retrieve
the properties for a certain map component the first time printing is triggered for that map component. |
Printable |
createPageDecorator(TLcyPrintContext aPrintContext)
Creates a
Printable that can be used to decorate each page. |
Pageable |
createPrintPageable(Pageable aViewPageable,
TLcyPrintContext aPrintContext)
Returns the
Pageable that is used for printing (not for preview printing),
based on the given Pageable . |
ALcyPrintableComponentFactory |
getPrintableComponentFactory()
Returns the
ALcyPrintableComponentFactory that is used by this addon. |
ILcyObjectCustomizerFactory |
getPrintAreaCustomizerFactory()
Returns the
ILcyObjectCustomizerFactory that is used by this addon. |
ILcdFilter |
getPrintAreaGXYLayerFilter()
Returns an
ILcdFilter that returns true if the given object is
an ILcdGXYLayer that represents the print area on the map,
false otherwise. |
TLcdPrintComponentAction |
getPrintComponentAction()
Deprecated.
only useful in prior to 6.1 mode
|
ALcyPrintPreviewFactory |
getPrintPreviewFactory()
Returns the
ALcyPrintPreviewFactory that is used by this addon. |
TLcyProperties |
getProperties(ILcyMapComponent aMapComponent)
Returns the
TLcyProperties for the given map component. |
void |
performQuickPrint(TLcyProperties aProperties,
ILcyMapComponent aMapComponent)
Trigger the print action for
aMapComponent with aProperties
containing all desired settings. |
void |
plugInto(ILcyLucyEnv aLucyEnv)
Plugs this addon into the given lucy environment.
|
void |
setPrintableComponentFactory(ALcyPrintableComponentFactory aPrintableComponentFactory)
Sets the
ALcyPrintableComponentFactory that should be used by this addon. |
void |
setPrintAreaCustomizerFactory(ILcyObjectCustomizerFactory aPrintAreaCustomizerFactory)
Sets the
ILcyObjectCustomizerFactory that should be used by this addon. |
void |
setPrintComponentAction(TLcdPrintComponentAction aPrintComponentAction)
Deprecated.
only useful in prior to 6.1 mode
|
void |
setPrintPreviewFactory(ALcyPrintPreviewFactory aPrintPreviewFactory)
Sets the
ALcyPrintPreviewFactory that should be used by this addon. |
void |
unplugFrom(ILcyLucyEnv aLucyEnv)
Unplugs this addon from the given Lucy environment.
|
getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName
public static final TLcyGroupDescriptor PRINT_GROUP_DESCRIPTOR
public static final String BACKGROUND_COLOR_MAP_KEY
java.awt.Color
.public static final Color BACKGROUND_COLOR_MAP_VALUE_DEFAULT
BACKGROUND_COLOR_MAP_KEY
.public static final String BACKGROUND_COLOR_MAP_OVERVIEW_KEY
java.awt.Color
.public static final Color BACKGROUND_COLOR_MAP_OVERVIEW_VALUE_DEFAULT
BACKGROUND_COLOR_MAP_OVERVIEW_KEY
.public static final String ORIENTATION_CHOICE_KEY
java.lang.String
.
Use ORIENTATION_CHOICE_VALUE_PORTRAIT
or ORIENTATION_CHOICE_VALUE_LANDSCAPE
public static final String ORIENTATION_CHOICE_VALUE_PORTRAIT
ORIENTATION_CHOICE_KEY
.public static final String ORIENTATION_CHOICE_VALUE_LANDSCAPE
ORIENTATION_CHOICE_KEY
.public static final String ORIENTATION_CHOICE_VALUE_DEFAULT
ORIENTATION_CHOICE_KEY
.public static final String PAGE_FORMAT_KEY
java.awt.print.PageFormat
.public static final String PRINTER_JOB_KEY
java.awt.print.PrinterJob
.public static final String PRINT_SERVICE_KEY
javax.print.PrintService
.public static final String SCALE_OR_PAGES_SUFFIX
java.lang.String
.
Use SCALE_OR_PAGES_VALUE_PAGES
or SCALE_OR_PAGES_VALUE_SCALE
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final String SCALE_OR_PAGES_VALUE_PAGES
SCALE_OR_PAGES_SUFFIX
.public static final String SCALE_OR_PAGES_VALUE_SCALE
SCALE_OR_PAGES_SUFFIX
.public static final String SCALE_OR_PAGES_VALUE_DEFAULT
SCALE_OR_PAGES_SUFFIX
.public static final String COL_COUNT_SUFFIX
java.lang.Integer
.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final int COL_COUNT_VALUE_DEFAULT
COL_COUNT_SUFFIX
.public static final String ROW_COUNT_SUFFIX
java.lang.Integer
.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final int ROW_COUNT_VALUE_DEFAULT
ROW_COUNT_SUFFIX
.public static final String SPECIFIC_SCALE_ITEMS_SUFFIX
java.lang.Double[]
.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final double[] SPECIFIC_SCALE_ITEMS_VALUE_DEFAULT
SPECIFIC_SCALE_ITEMS_SUFFIX
.public static final String SPECIFIC_SCALE_SUFFIX
java.lang.Double
.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final double SPECIFIC_SCALE_VALUE_DEFAULT
SPECIFIC_SCALE_SUFFIX
.public static final String SNAP_TO_FULL_PAGES_VISIBLE_SUFFIX
java.lang.Boolean
.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final boolean SNAP_TO_FULL_PAGES_VISIBLE_VALUE_DEFAULT
SNAP_TO_FULL_PAGES_VISIBLE_SUFFIX
.public static final String SNAP_TO_FULL_PAGES_SELECTED_SUFFIX
java.lang.Boolean
.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final boolean SNAP_TO_FULL_PAGES_SELECTED_VALUE_DEFAULT
SNAP_TO_FULL_PAGES_SELECTED_SUFFIX
.public static final String PRINT_AREA_SUFFIX
ILcdBounds
and it uses the
world reference from the map component in which the print area has been created.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.public static final ILcdBounds PRINT_AREA_VALUE_DEFAULT
PRINT_AREA_SUFFIX
.@Deprecated public static final String INCLUDES_COVERED_AREA_SUFFIX
PRINTING_AREA_CHOICE_KEY
property
(PRINTING_AREA_CHOICE_VALUE_PRINT_AREA
-> true, otherwise false).PRINT_AREA_SUFFIX
.
The corresponding property value is of type java.lang.Boolean
.
Please refer to PRINTING_AREA_CHOICE_KEY
for more information.@Deprecated public static final boolean INCLUDES_COVERED_AREA_VALUE_DEFAULT
INCLUDES_COVERED_AREA_SUFFIX
.INCLUDES_COVERED_AREA_SUFFIX
.public static final String PRINTING_AREA_CHOICE_KEY
PRINTING_AREA_PREFIX
and "." plus the suffix of the property you want to
create.
For example, PRINTING_AREA_PREFIX
+ PRINTING_AREA_CHOICE_VALUE_VIEW_EXTENTS
+
"." + COL_COUNT_SUFFIX
represents the property key corresponding to the number of columns
the printing area PRINTING_AREA_CHOICE_VALUE_VIEW_EXTENTS
should use.
The corresponding property value is of type java.lang.String
.
public static final String PRINTING_AREA_CHOICE_VALUE_VIEW_EXTENTS
PRINTING_AREA_CHOICE_KEY
.public static final String PRINTING_AREA_CHOICE_VALUE_PRINT_AREA
PRINTING_AREA_CHOICE_KEY
.public static final String PRINTING_AREA_CHOICE_VALUE_DEFAULT
PRINTING_AREA_CHOICE_KEY
.public static final String PRINTING_AREA_PREFIX
PRINTING_AREA_CHOICE_KEY
for more information.public static final String CROP_MARKS_VISIBLE_KEY
java.lang.Boolean
.public static final boolean CROP_MARKS_VISIBLE_VALUE_DEFAULT
CROP_MARKS_VISIBLE_KEY
.public static final String CROP_MARKS_SELECTED_KEY
java.lang.Boolean
.public static final boolean CROP_MARKS_SELECTED_VALUE_DEFAULT
CROP_MARKS_SELECTED_KEY
.public static final String POSITION_MARKS_VISIBLE_KEY
java.lang.Boolean
.public static final boolean POSITION_MARKS_VISIBLE_VALUE_DEFAULT
POSITION_MARKS_VISIBLE_KEY
.public static final String POSITION_MARKS_SELECTED_KEY
java.lang.Boolean
.public static final boolean POSITION_MARKS_SELECTED_VALUE_DEFAULT
POSITION_MARKS_SELECTED_KEY
.public static final String TITLE_TEXT_VISIBLE_KEY
java.lang.Boolean
.public static final boolean TITLE_TEXT_VISIBLE_VALUE_DEFAULT
TITLE_TEXT_VISIBLE_KEY
.public static final String TITLE_TEXT_SELECTED_KEY
java.lang.Boolean
.public static final boolean TITLE_TEXT_SELECTED_VALUE_DEFAULT
TITLE_TEXT_SELECTED_KEY
.public static final String TITLE_TEXT_FIELD_VISIBLE_KEY
java.lang.Boolean
.public static final boolean TITLE_TEXT_FIELD_VISIBLE_VALUE_DEFAULT
TITLE_TEXT_FIELD_VISIBLE_KEY
.public static final String TITLE_TEXT_KEY
java.lang.String
.public static final String TITLE_TEXT_VALUE_DEFAULT
TITLE_TEXT_KEY
.public static final String MODIFIABLE_HEADER_TEXT_VISIBLE_KEY
java.lang.Boolean
.
The difference with the #HEADER_TEXT_*
properties is that this property
controls the header text which is modifiable in the UI by the user.public static final boolean MODIFIABLE_HEADER_TEXT_VISIBLE_VALUE_DEFAULT
MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_KEY
public static final String MODIFIABLE_HEADER_TEXT_SELECTED_KEY
java.lang.Boolean
.
The difference with the #HEADER_TEXT_*
properties is that this property
controls the header text which is modifiable in the UI by the user.public static final boolean MODIFIABLE_HEADER_TEXT_SELECTED_VALUE_DEFAULT
MODIFIABLE_HEADER_TEXT_SELECTED_KEY
public static final String MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_KEY
java.lang.Boolean
.
The difference with the #HEADER_TEXT_*
properties is that this property
controls the header text which is modifiable in the UI by the user.public static final boolean MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_VALUE_DEFAULT
MODIFIABLE_HEADER_TEXT_FIELD_VISIBLE_KEY
public static final String MODIFIABLE_HEADER_TEXT_KEY
java.lang.String
.
The difference with the #HEADER_TEXT_*
properties is that this property
controls the header text which is modifiable in the UI by the user.public static final String MODIFIABLE_HEADER_TEXT_VALUE_DEFAULT
MODIFIABLE_HEADER_TEXT_KEY
public static final String CLASSIFICATION_VISIBLE_KEY
java.lang.Boolean
.public static final boolean CLASSIFICATION_VISIBLE_VALUE_DEFAULT
CLASSIFICATION_VISIBLE_KEY
public static final String CLASSIFICATION_SELECTED_KEY
java.lang.Boolean
public static final boolean CLASSIFICATION_SELECTED_VALUE_DEFAULT
CLASSIFICATION_SELECTED_KEY
public static final String CLASSIFICATION_COMBO_BOX_VISIBLE_KEY
java.lang.Boolean
public static final boolean CLASSIFICATION_COMBO_BOX_VISIBLE_VALUE_DEFAULT
CLASSIFICATION_COMBO_BOX_VISIBLE_KEY
public static final String CLASSIFICATION_KEY
java.lang.String
public static final String HEADER_TEXT_VISIBLE_KEY
java.lang.Boolean
.public static final boolean HEADER_TEXT_VISIBLE_VALUE_DEFAULT
HEADER_TEXT_VISIBLE_KEY
.public static final String HEADER_TEXT_SELECTED_KEY
java.lang.Boolean
.public static final boolean HEADER_TEXT_SELECTED_VALUE_DEFAULT
HEADER_TEXT_SELECTED_KEY
.public static final String HEADER_TEXT_KEY
java.lang.String
.public static final String HEADER_TEXT_VALUE_DEFAULT
HEADER_TEXT_KEY
.public static final String FOOTER_TEXT_VISIBLE_KEY
java.lang.Boolean
.public static final boolean FOOTER_TEXT_VISIBLE_VALUE_DEFAULT
FOOTER_TEXT_VISIBLE_KEY
.public static final String FOOTER_TEXT_SELECTED_KEY
java.lang.Boolean
.public static final boolean FOOTER_TEXT_SELECTED_VALUE_DEFAULT
FOOTER_TEXT_SELECTED_KEY
.public static final String FOOTER_TEXT_KEY
java.lang.String
.public static final String FOOTER_TEXT_VALUE_DEFAULT
FOOTER_TEXT_KEY
.public static final String LEGEND_VISIBLE_KEY
java.lang.Boolean
.public static final boolean LEGEND_VISIBLE_VALUE_DEFAULT
LEGEND_VISIBLE_KEY
.public static final String LEGEND_SELECTED_KEY
java.lang.Boolean
.public static final boolean LEGEND_SELECTED_VALUE_DEFAULT
LEGEND_SELECTED_KEY
.public static final String OVERVIEW_VISIBLE_KEY
java.lang.Boolean
.public static final boolean OVERVIEW_VISIBLE_VALUE_DEFAULT
OVERVIEW_VISIBLE_KEY
.public static final String OVERVIEW_ENABLED_KEY
java.lang.Boolean
.public static final boolean OVERVIEW_ENABLED_VALUE_DEFAULT
OVERVIEW_ENABLED_KEY
.public static final String OVERVIEW_SELECTED_KEY
java.lang.Boolean
.public static final boolean OVERVIEW_SELECTED_VALUE_DEFAULT
OVERVIEW_SELECTED_KEY
.public static final String SCALE_ICON_VISIBLE_KEY
java.lang.Boolean
.public static final boolean SCALE_ICON_VISIBLE_VALUE_DEFAULT
SCALE_ICON_VISIBLE_KEY
.public static final String SCALE_ICON_SELECTED_KEY
java.lang.Boolean
.public static final boolean SCALE_ICON_SELECTED_VALUE_DEFAULT
SCALE_ICON_SELECTED_KEY
.public static final String SCALE_TEXT_VISIBLE_KEY
java.lang.Boolean
.public static final boolean SCALE_TEXT_VISIBLE_VALUE_DEFAULT
SCALE_TEXT_VISIBLE_KEY
.public static final String SCALE_TEXT_SELECTED_KEY
java.lang.Boolean
.public static final boolean SCALE_TEXT_SELECTED_VALUE_DEFAULT
SCALE_TEXT_SELECTED_KEY
.public static final String RASTERIZATION_QUALITY_KEY
java.lang.Integer
.
Use a value between the values of RASTERIZATION_QUALITY_MINIMUM_KEY
and RASTERIZATION_QUALITY_MAXIMUM_KEY
.public static final int RASTERIZATION_QUALITY_VALUE_DEFAULT
RASTERIZATION_QUALITY_KEY
.public static final String RASTERIZATION_QUALITY_ITEMS_KEY
RASTERIZATION_QUALITY_MINIMUM_KEY
and
RASTERIZATION_QUALITY_MAXIMUM_KEY
.public static final int[] RASTERIZATION_QUALITY_ITEMS_VALUE_DEFAULT
RASTERIZATION_QUALITY_ITEMS_KEY
.
The default value is null, which means that the RASTERIZATION_QUALITY_MINIMUM_KEY
and
RASTERIZATION_QUALITY_MAXIMUM_KEY
values should be used to determine the values.public static final String RASTERIZATION_QUALITY_LABELS_KEY
public static final String[] RASTERIZATION_QUALITY_LABELS_VALUE_DEFAULT
RASTERIZATION_QUALITY_LABELS_KEY
.
The default value is null, which means that the labels are based on the values (e.g. a value of 72 gets the label "72 dpi").public static final String RASTERIZATION_QUALITY_MINIMUM_KEY
java.lang.Integer
.public static final int RASTERIZATION_QUALITY_MINIMUM_VALUE_DEFAULT
RASTERIZATION_QUALITY_MINIMUM_KEY
.public static final String RASTERIZATION_QUALITY_MAXIMUM_KEY
java.lang.Integer
.public static final int RASTERIZATION_QUALITY_MAXIMUM_VALUE_DEFAULT
RASTERIZATION_QUALITY_MAXIMUM_KEY
.public static final String RASTERIZATION_QUALITY_VISIBLE_KEY
java.lang.Boolean
.public static final boolean RASTERIZATION_QUALITY_VISIBLE_VALUE_DEFAULT
RASTERIZATION_QUALITY_VISIBLE_KEY
.public static final String PRINT_SCALE_KEY
More specifically, the property value determines the size of a pixel, when printed. When for example an icon of 16x16 pixels is visible on the map, and the print factor is set to 1.0 (meaning 72 pixels per inch), that icon will appear on the printout as approximately 16/72=0.22 inch or 5.6 millimeter.
The corresponding property value is of type java.lang.Double
.
Use a value between the values PRINT_SCALE_MINIMUM_KEY
and
PRINT_SCALE_MAXIMUM_KEY
.
public static final double PRINT_SCALE_VALUE_DEFAULT
PRINT_SCALE_KEY
, expressed as a percentage (0.95 means 95%).public static final String PRINT_SCALE_ITEMS_KEY
PRINT_SCALE_MINIMUM_KEY
and
PRINT_SCALE_MAXIMUM_KEY
.public static final double[] PRINT_SCALE_ITEMS_VALUE_DEFAULT
PRINT_SCALE_ITEMS_KEY
.
The default value is null, which means that the PRINT_SCALE_MINIMUM_KEY
and
PRINT_SCALE_MAXIMUM_KEY
values should be used to determine the values.public static final String PRINT_SCALE_MINIMUM_KEY
java.lang.Integer
.public static final double PRINT_SCALE_MINIMUM_VALUE_DEFAULT
PRINT_SCALE_MINIMUM_KEY
.public static final String PRINT_SCALE_MAXIMUM_KEY
java.lang.Integer
.public static final double PRINT_SCALE_MAXIMUM_VALUE_DEFAULT
PRINT_SCALE_MAXIMUM_KEY
.public static final String PRINT_SCALE_VISIBLE_KEY
java.lang.Boolean
.public static final boolean PRINT_SCALE_VISIBLE_VALUE_DEFAULT
PRINT_SCALE_VISIBLE_KEY
.public static final String TRANSPARENCY_HANDLING_KEY
java.lang.Integer
.
Use TRANSPARENCY_HANDLING_VALUE_JAVA_PRINTING
, TRANSPARENCY_HANDLING_VALUE_MEMORY_OPTIMIZED
or TRANSPARENCY_HANDLING_VALUE_VECTOR_OPTIMIZED
public static final int TRANSPARENCY_HANDLING_VALUE_DEFAULT
TRANSPARENCY_HANDLING_KEY
public static final int TRANSPARENCY_HANDLING_VALUE_JAVA_PRINTING
TRANSPARENCY_HANDLING_KEY
public static final int TRANSPARENCY_HANDLING_VALUE_MEMORY_OPTIMIZED
TRANSPARENCY_HANDLING_KEY
public static final int TRANSPARENCY_HANDLING_VALUE_VECTOR_OPTIMIZED
TRANSPARENCY_HANDLING_KEY
public static final String PREVIEW_SCALE_ITEMS_KEY
java.lang.Double[]
.
A value of 0.85 means 85%.public static final double[] PREVIEW_SCALE_ITEMS_VALUE_DEFAULT
PREVIEW_SCALE_ITEMS_KEY
public static final String PREVIEW_SCALE_KEY
java.lang.Double
.
A value of 0.85 means 85%.public static final double PREVIEW_SCALE_VALUE_DEFAULT
PREVIEW_SCALE_KEY
public static final String PREVIEW_PAGES_LIMIT_KEY
java.lang.Integer
.public static final int PREVIEW_PAGES_LIMIT_VALUE_DEFAULT
PREVIEW_PAGES_LIMIT_KEY
public static final String PRINT_PAGES_LIMIT_KEY
java.lang.Integer
.public static final int PRINT_PAGES_LIMIT_VALUE_DEFAULT
PRINT_PAGES_LIMIT_KEY
public TLcyPrintAddOn()
plugInto
method must also be called.
This is typically done by a ILcyLucyEnv
instance, upon request of the application front-end.public void plugInto(ILcyLucyEnv aLucyEnv)
ALcyAddOn
plugInto
in class ALcyAddOn
aLucyEnv
- The lucy environment to plug into.ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)
@Deprecated public TLcdPrintComponentAction getPrintComponentAction()
TLcdPrintComponentAction
that this addon delegates to.TLcdPrintComponentAction
that this addon delegates to.@Deprecated public void setPrintComponentAction(TLcdPrintComponentAction aPrintComponentAction)
TLcdPrintComponentAction
this addon delegates to.aPrintComponentAction
- The print component action.public ALcyPrintableComponentFactory getPrintableComponentFactory()
ALcyPrintableComponentFactory
that is used by this addon.ALcyPrintableComponentFactory
that is used by this addon.public void setPrintableComponentFactory(ALcyPrintableComponentFactory aPrintableComponentFactory)
ALcyPrintableComponentFactory
that should be used by this addon.
Please refer to TLcyPrintAddOn
for more information.aPrintableComponentFactory
- The printable component factory.public ALcyPrintPreviewFactory getPrintPreviewFactory()
ALcyPrintPreviewFactory
that is used by this addon.ALcyPrintPreviewFactory
that is used by this addon.public void setPrintPreviewFactory(ALcyPrintPreviewFactory aPrintPreviewFactory)
ALcyPrintPreviewFactory
that should be used by this addon.
Please refer to TLcyPrintAddOn
for more information.aPrintPreviewFactory
- The print preview factory.public ILcyObjectCustomizerFactory getPrintAreaCustomizerFactory()
ILcyObjectCustomizerFactory
that is used by this addon.ILcyObjectCustomizerFactory
that is used by this addon.public void setPrintAreaCustomizerFactory(ILcyObjectCustomizerFactory aPrintAreaCustomizerFactory)
ILcyObjectCustomizerFactory
that should be used by this addon.
Please refer to TLcyPrintAddOn
for more information.aPrintAreaCustomizerFactory
- The object customizer factory.public TLcyProperties getProperties(ILcyMapComponent aMapComponent)
TLcyProperties
for the given map component. These are the current
stored values of the properties used in the print addon.
Please refer to TLcyPrintAddOn
for more information.
Note that if you want to change the default properties (=the properties used the first time
printing is triggered for a certain map component), it is best to override the createDefaultProperties(ILcyMapComponent)
method instead.aMapComponent
- The map component to query.TLcyProperties
for the given map component.protected TLcyProperties createDefaultProperties(ILcyMapComponent aMapComponent)
This method is used by the getProperties(ILcyMapComponent)
method to retrieve
the properties for a certain map component the first time printing is triggered for that map component.
By default this method returns a TLcyProperties
instance containing the settings defined in the
configuration file.
You can override this method to for example add extra settings to those properties.
Note that you can add those extra settings as well by putting them in the configuration file.
It is important that this method always returns a new TLcyProperties
instance to avoid that
changing the settings of one map component would affect the settings of another map component.
aMapComponent
- The map componentTLcyProperties
for the given map component.getProperties(ILcyMapComponent)
public ILcdFilter getPrintAreaGXYLayerFilter()
ILcdFilter
that returns true if the given object is
an ILcdGXYLayer
that represents the print area on the map,
false otherwise. This can be used by custom legend implementations to avoid
listing the print area layer.public void performQuickPrint(TLcyProperties aProperties, ILcyMapComponent aMapComponent)
Trigger the print action for aMapComponent
with aProperties
containing all desired settings.
This method allows you to perform a print action through the API.
aProperties
- The properties containing the desired print settings.aMapComponent
- The map component which must be printed.public void unplugFrom(ILcyLucyEnv aLucyEnv)
ALcyAddOn
unplugFrom
in class ALcyAddOn
aLucyEnv
- The lucy environment to unplug from.ALcyAddOn.plugInto(com.luciad.lucy.ILcyLucyEnv)
public Printable createPageDecorator(TLcyPrintContext aPrintContext)
Creates a Printable
that can be used to decorate each page. It is for example possible
to add a watermark to each page by overriding this method.
By default, this method returns null
, meaning that no decorations are added.
aPrintContext
- the print context.Printable
that can be used to decorate each page.public Pageable createPrintPageable(Pageable aViewPageable, TLcyPrintContext aPrintContext)
Returns the Pageable
that is used for printing (not for preview printing),
based on the given Pageable
. The given Pageable
is used to print
the view. Override this method to return a custom Pageable
, e.g. by wrapping
the given Pageable
. It is for example possible to add a title page by overriding
this method.
By default, this method returns aViewPageable
.
aViewPageable
- the Pageable
that is capable to print the view.aPrintContext
- the print context.Pageable
that is used for printing