com.ail.core.document.model
Class BlockData

java.lang.Object
  com.ail.core.Type
      com.ail.core.document.model.ItemData
          com.ail.core.document.model.ItemContainer
              com.ail.core.document.model.BlockData

All Implemented Interfaces:

Identified, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FooterData, HeaderData

public class BlockData
extends ItemContainer

An instance of BlockData defines the data that should appear in some area of the rendered document.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ail.core.Type

jXPathContext, NOT_PERSISTED

Constructor Summary

BlockData()

Method Summary

Applicability	getApplicability() Return an indicator detailiing which where this block is applicable (should be shown) in the document.
java.lang.String	getApplicabilityAsString()
Placement	getPlacement() Get an indicator detailing where this block should be included on the page.
java.lang.String	getPlacementAsString()
java.lang.String	getWatermark() If the block has a watermark (image) this property holds it's URL.
void	render(RenderContext context) Default implementation of the render method; implementing class will generally override this.
void	setApplicability(Applicability applicability)
void	setApplicabilityAsString(java.lang.String applicability)
void	setPlacement(Placement position)
void	setPlacementAsString(java.lang.String position)
void	setWatermark(java.lang.String watermark)

Methods inherited from class com.ail.core.document.model.ItemContainer

getItem, setItem

Methods inherited from class com.ail.core.document.model.ItemData

compareById, getId, getOrder, getStyle, getTitle, getValue, setId, setOrder, setStyle, setTitle, setValue

Methods inherited from class com.ail.core.Type

addAttribute, clone, deleteLock, deleteSerialVersion, fetchJXPathContext, getAttribute, getAttribute, getAttributeCount, getForeignSystemId, getLock, getSerialVersion, getSystemId, hasLock, hasSerialVersion, hasSystemId, isPersisted, markAsNotPersisted, mergeWithDataFrom, removeAttribute, removeAttribute, setAttribute, setForeignSystemId, setLock, setSerialVersion, setSystemId, xpathGet, xpathGet, xpathIterate, xpathSet

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockData

public BlockData()

Method Detail

getApplicability

public Applicability getApplicability()

Return an indicator detailiing which where this block is applicable (should be shown) in the document.

Returns:

Applicability indicator.

setApplicability

public void setApplicability(Applicability applicability)

Parameters:

applicability -

See Also:

getApplicability()

setApplicabilityAsString

public void setApplicabilityAsString(java.lang.String applicability)

Parameters:

applicability -

See Also:

getApplicability()

getApplicabilityAsString

public java.lang.String getApplicabilityAsString()

Parameters:

applicability -

See Also:

getApplicability()

getPlacement

public Placement getPlacement()

Get an indicator detailing where this block should be included on the page.

Returns:

Placement indicator.

getPlacementAsString

public java.lang.String getPlacementAsString()

Parameters:

applicability -

See Also:

getPlacement()

setPlacementAsString

public void setPlacementAsString(java.lang.String position)

Parameters:

applicability -

See Also:

getPlacement()

setPlacement

public void setPlacement(Placement position)

Parameters:

applicability -

See Also:

getPlacement()

render

public void render(RenderContext context)

Description copied from class: ItemContainer

Default implementation of the render method; implementing class will generally override this.

Overrides:

render in class ItemContainer

getWatermark

public java.lang.String getWatermark()

If the block has a watermark (image) this property holds it's URL.

Returns:

watermark URL

setWatermark

public void setWatermark(java.lang.String watermark)

Parameters:

watermark -

See Also:

getWatermark()