org.mapfish.print.config.layout

Class Block

java.lang.Object

org.mapfish.print.config.layout.Block

Direct Known Subclasses:

AttributesBlock, ColumnsBlock, FontBlock, ImageBlock, LegendsBlock, MapBlock

public abstract class Block
extends java.lang.Object

Base class for blocks that can be found in "items" arrays.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Block.PdfElement

Field Summary

Fields

Modifier and Type	Field and Description
protected HorizontalAlign	align
static java.util.regex.Pattern	CONDITION_REGEXP
protected double	spacingAfter

Constructor Summary

Constructors

Constructor and Description
Block()

Method Summary

Methods

Modifier and Type	Method and Description
HorizontalAlign	getAlign()
com.itextpdf.text.BaseColor	getBackgroundColorVal(RenderingContext context, PJsonObject params)
MapBlock	getMap(java.lang.String name)
protected double	getMaxValueIfZero(double value, java.lang.String exceptionName)
protected float	getMaxValueIfZero(float value, java.lang.String exceptionName)
VerticalAlign	getVertAlign()
boolean	isAbsolute()
boolean	isVisible(RenderingContext context, PJsonObject params)
abstract void	render(PJsonObject params, Block.PdfElement target, RenderingContext context) Called when the block is rendered.
void	setAlign(HorizontalAlign align)
void	setBackgroundColor(java.lang.String backgroundColor)
void	setCondition(java.lang.String condition)
void	setSpacingAfter(double spacingAfter)
void	setVertAlign(VerticalAlign vertAlign)
static boolean	testCondition(RenderingContext context, PJsonObject params, java.lang.String condition)
void	validate() Called just after the config has been loaded to check it is valid.

Methods inherited from class java.lang.Object

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

Field Detail

align

protected HorizontalAlign align

spacingAfter

protected double spacingAfter

CONDITION_REGEXP

public static final java.util.regex.Pattern CONDITION_REGEXP

Constructor Detail

Block

public Block()

Method Detail

render

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

Called when the block is rendered.

Throws:

com.itextpdf.text.DocumentException

getMap

public MapBlock getMap(java.lang.String name)

validate

public void validate()

Called just after the config has been loaded to check it is valid.

Throws:

InvalidValueException - When there is a problem

isAbsolute

public boolean isAbsolute()

setAlign

public void setAlign(HorizontalAlign align)

setVertAlign

public void setVertAlign(VerticalAlign vertAlign)

getBackgroundColorVal

public com.itextpdf.text.BaseColor getBackgroundColorVal(RenderingContext context,
                                                PJsonObject params)

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

getAlign

public HorizontalAlign getAlign()

getVertAlign

public VerticalAlign getVertAlign()

testCondition

public static final boolean testCondition(RenderingContext context,
                    PJsonObject params,
                    java.lang.String condition)

isVisible

public boolean isVisible(RenderingContext context,
                PJsonObject params)

setCondition

public void setCondition(java.lang.String condition)

setSpacingAfter

public void setSpacingAfter(double spacingAfter)

getMaxValueIfZero

protected double getMaxValueIfZero(double value,
                       java.lang.String exceptionName)

getMaxValueIfZero

protected float getMaxValueIfZero(float value,
                      java.lang.String exceptionName)