org.mapfish.print.config.layout

Class LegendsBlock

java.lang.Object

org.mapfish.print.config.layout.Block

org.mapfish.print.config.layout.LegendsBlock

public class LegendsBlock
extends Block

Bean to configure a !legends block.

See http://trac.mapfish.org/trac/mapfish/wiki/PrintModuleServer#Legendsblock

Nested Class Summary

Nested classes/interfaces inherited from class org.mapfish.print.config.layout.Block

Block.PdfElement

Field Summary

Fields

Modifier and Type	Field and Description
protected float	classFontSize
protected float	layerFontSize
static org.apache.log4j.Logger	LOGGER

Fields inherited from class org.mapfish.print.config.layout.Block

align, CONDITION_REGEXP, spacingAfter

Constructor Summary

Constructors

Constructor and Description
LegendsBlock()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassFont()
protected com.itextpdf.text.Font	getClassPdfFont() classes' texts font
protected com.itextpdf.text.Font	getLayerPdfFont() layers' texts font
void	render(PJsonObject params, Block.PdfElement target, RenderingContext context) Render the legends block
void	setBorders(boolean value) Do we have borders for debugging?
void	setClassFont(java.lang.String classFont) font of class legend items' texts
void	setClassFontSize(double classFontSize) font size for class legend items' texts
void	setClassIndentation(double classIndentation) horizontal indentation of class legend items
void	setClassSpace(double classSpace) vertical space AFTER class legend items
void	setColumnMargin(java.lang.String columnMargin) CSS style margin of each legend column
void	setDefaultScale(double scale) 1.0 or null for no scaling >1.0 to increase size, < 1.0 to decrease
void	setFontEncoding(java.lang.String fontEncoding) Font encoding
void	setHorizontalAlignment(java.lang.String value) set the horizontal alignment of legend items inside the table and the table itself
void	setIconMaxHeight(double maxIconHeight) maximum height of legend icon/image currently SVG icons get scaled to this if not present icons get scaled preserving ratio with iconMaxWidth
void	setIconMaxWidth(double maxIconWidth) maximum width a legend icon/image can have currently SVG icons are scaled to fit this
void	setIconPadding(java.lang.String values) CSS style padding around legend icon/image
void	setInline(boolean inline) Whether legend icons/images should appear on the same line as the legend text, has nothing to do with multi-column layout.
void	setLayerFont(java.lang.String layerFont)
void	setLayerFontSize(double layerFontSize)
void	setLayerSpace(double layerSpace) vertical space AFTER the legend items
void	setLayerSpaceBefore(double layerSpaceBefore)
void	setMaxHeight(double maxHeight) set maximum height of a legend column
void	setMaxWidth(double maxWidth) set maximum width of legend items i.e.
void	setTextMaxWidth(double textMaxWidth)
void	setTextPadding(java.lang.String values) CSS style padding around legend text/name

Methods inherited from class org.mapfish.print.config.layout.Block

getAlign, getBackgroundColorVal, getMap, getMaxValueIfZero, getMaxValueIfZero, getVertAlign, isAbsolute, isVisible, setAlign, setBackgroundColor, setCondition, setSpacingAfter, setVertAlign, testCondition, validate

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.apache.log4j.Logger LOGGER

layerFontSize

protected float layerFontSize

classFontSize

protected float classFontSize

Constructor Detail

LegendsBlock

public LegendsBlock()

Method Detail

render

public void render(PJsonObject params,
                   Block.PdfElement target,
                   RenderingContext context)
            throws com.itextpdf.text.DocumentException

Render the legends block

Specified by:

render in class Block

Parameters:

params -

target -

context -

Throws:

com.lowagie.text.DocumentException

com.itextpdf.text.DocumentException

See Also:

Block.render( org.mapfish.print.utils.PJsonObject, org.mapfish.print.config.layout.Block.PdfElement, org.mapfish.print.RenderingContext)

setMaxWidth

public void setMaxWidth(double maxWidth)

set maximum width of legend items i.e. the legend tables

Parameters:

maxWidth -

setMaxHeight

public void setMaxHeight(double maxHeight)

set maximum height of a legend column

Parameters:

maxHeight - if 0 means the column can be as hight as possible

setDefaultScale

public void setDefaultScale(double scale)

1.0 or null for no scaling >1.0 to increase size, < 1.0 to decrease

Parameters:

scale - scale icon/image by this

setInline

public void setInline(boolean inline)

Whether legend icons/images should appear on the same line as the legend text, has nothing to do with multi-column layout.

Parameters:

inline - true of false

setIconMaxWidth

public void setIconMaxWidth(double maxIconWidth)

maximum width a legend icon/image can have currently SVG icons are scaled to fit this

Parameters:

maxIconWidth -

setIconMaxHeight

public void setIconMaxHeight(double maxIconHeight)

maximum height of legend icon/image currently SVG icons get scaled to this if not present icons get scaled preserving ratio with iconMaxWidth

Parameters:

maxIconHeight -

setClassIndentation

public void setClassIndentation(double classIndentation)

horizontal indentation of class legend items

Parameters:

classIndentation -

setClassFont

public void setClassFont(java.lang.String classFont)

font of class legend items' texts

Parameters:

classFont -

setClassFontSize

public void setClassFontSize(double classFontSize)

font size for class legend items' texts

Parameters:

classFontSize -

getClassFont

public java.lang.String getClassFont()

getLayerPdfFont

protected com.itextpdf.text.Font getLayerPdfFont()

layers' texts font

Returns:

Font used for layers' texts but not for classes

getClassPdfFont

protected com.itextpdf.text.Font getClassPdfFont()

classes' texts font

Returns:

Font used for class items

setLayerSpace

public void setLayerSpace(double layerSpace)

vertical space AFTER the legend items

Parameters:

layerSpace -

setClassSpace

public void setClassSpace(double classSpace)

vertical space AFTER class legend items

Parameters:

classSpace -

setLayerFont

public void setLayerFont(java.lang.String layerFont)

Parameters:

layerFont - Font name used for layer items, not classes

setLayerFontSize

public void setLayerFontSize(double layerFontSize)

Parameters:

layerFontSize - font size used for layer items

setFontEncoding

public void setFontEncoding(java.lang.String fontEncoding)

Font encoding

Parameters:

fontEncoding -

setColumnMargin

public void setColumnMargin(java.lang.String columnMargin)

CSS style margin of each legend column

Parameters:

columnMargin -

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.String value)

set the horizontal alignment of legend items inside the table and the table itself

Parameters:

value - left|center|right

setIconPadding

public void setIconPadding(java.lang.String values)

CSS style padding around legend icon/image

Parameters:

values -

setTextPadding

public void setTextPadding(java.lang.String values)

CSS style padding around legend text/name

Parameters:

values -

setBorders

public void setBorders(boolean value)

Do we have borders for debugging?

Parameters:

value -

setTextMaxWidth

public void setTextMaxWidth(double textMaxWidth)

Parameters:

textMaxWidth - the textMaxWidth to set

setLayerSpaceBefore

public void setLayerSpaceBefore(double layerSpaceBefore)

Parameters:

layerSpaceBefore - the layerSpaceBefore to set