net.sf.jasperreports.engine.base

Class JRBaseParagraph

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseParagraph

All Implemented Interfaces:

Serializable, Cloneable, Deduplicable, JRChangeEventsSupport, JRParagraph, JRStyleContainer

public class JRBaseParagraph
extends Object
implements JRParagraph, Serializable, Cloneable, JRChangeEventsSupport, Deduplicable

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	firstLineIndent
protected Integer	leftIndent
protected LineSpacingEnum	lineSpacing
protected Float	lineSpacingSize
protected JRParagraphContainer	paragraphContainer
static String	PROPERTY_FIRST_LINE_INDENT
static String	PROPERTY_LEFT_INDENT
static String	PROPERTY_LINE_SPACING
static String	PROPERTY_LINE_SPACING_SIZE
static String	PROPERTY_RIGHT_INDENT
static String	PROPERTY_SPACING_AFTER
static String	PROPERTY_SPACING_BEFORE
static String	PROPERTY_TAB_STOP_WIDTH
static String	PROPERTY_TAB_STOPS
protected Integer	rightIndent
protected Integer	spacingAfter
protected Integer	spacingBefore
protected List<TabStop>	tabStops
protected Integer	tabStopWidth

Fields inherited from interface net.sf.jasperreports.engine.JRParagraph

DEFAULT_FIRST_LINE_INDENT, DEFAULT_LEFT_INDENT, DEFAULT_LINE_SPACING_SIZE, DEFAULT_RIGHT_INDENT, DEFAULT_SPACING_AFTER, DEFAULT_SPACING_BEFORE, DEFAULT_TAB_STOP_WIDTH

Constructor Summary

Constructors

Constructor and Description
JRBaseParagraph(JRParagraphContainer paragraphContainer)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTabStop(int index, TabStop tabStop)
void	addTabStop(TabStop tabStop)
JRParagraph	clone(JRParagraphContainer paragraphContainer)
JRDefaultStyleProvider	getDefaultStyleProvider()
JRPropertyChangeSupport	getEventSupport() Returns the property change support object for this instance.
Integer	getFirstLineIndent() Gets the text first line indent.
int	getHashCode() Returns a hash code to be used for the deduplicate map.
Integer	getLeftIndent() Gets the text left indent.
LineSpacingEnum	getLineSpacing() Gets the text line spacing.
Float	getLineSpacingSize() Gets the text line spacing size to be used in combination with the line spacing type.
Integer	getOwnFirstLineIndent() Gets the text own first line indent.
Integer	getOwnLeftIndent() Gets the text own left indent.
LineSpacingEnum	getOwnLineSpacing() Gets the text own line spacing.
Float	getOwnLineSpacingSize() Gets the text own line spacing size to be used in combination with the line spacing type.
Integer	getOwnRightIndent() Gets the text own right indent.
Integer	getOwnSpacingAfter() Gets the text own spacing after.
Integer	getOwnSpacingBefore() Gets the text own spacing before.
TabStop[]	getOwnTabStops() Gets the custom tab stops.
Integer	getOwnTabStopWidth() Gets the text own tab stop width.
JRParagraphContainer	getParagraphContainer()
Integer	getRightIndent() Gets the text right indent.
Integer	getSpacingAfter() Gets the text spacing after.
Integer	getSpacingBefore() Gets the text spacing before.
JRStyle	getStyle() Returns this object's style.
String	getStyleNameReference() Returns the name of an external style which is to be used by this object.
TabStop[]	getTabStops() Gets the custom tab stops.
Integer	getTabStopWidth() Gets the text tab stop width.
boolean	isIdentical(Object object) Determines if this instance is identical to another object.
void	removeTabStop(int index)
void	removeTabStop(TabStop tabStop)
void	setFirstLineIndent(Integer firstLineIndent) Sets the text own first line indent.
void	setLeftIndent(Integer leftIndent) Sets the text own left indent.
void	setLineSpacing(LineSpacingEnum lineSpacing) Sets the text line spacing.
void	setLineSpacingSize(Float lineSpacingSize) Sets the text line spacing size to be used in combination with the line spacing type.
void	setRightIndent(Integer rightIndent) Sets the text own right indent.
void	setSpacingAfter(Integer spacingAfter) Sets the text own spacing after.
void	setSpacingBefore(Integer spacingBefore) Sets the text own spacing before.
void	setTabStopWidth(Integer tabStopWidth) Sets the text own tab stop width.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_LINE_SPACING

public static final String PROPERTY_LINE_SPACING

See Also:

Constant Field Values

PROPERTY_LINE_SPACING_SIZE

public static final String PROPERTY_LINE_SPACING_SIZE

See Also:

Constant Field Values

PROPERTY_FIRST_LINE_INDENT

public static final String PROPERTY_FIRST_LINE_INDENT

See Also:

Constant Field Values

PROPERTY_LEFT_INDENT

public static final String PROPERTY_LEFT_INDENT

See Also:

Constant Field Values

PROPERTY_RIGHT_INDENT

public static final String PROPERTY_RIGHT_INDENT

See Also:

Constant Field Values

PROPERTY_SPACING_BEFORE

public static final String PROPERTY_SPACING_BEFORE

See Also:

Constant Field Values

PROPERTY_SPACING_AFTER

public static final String PROPERTY_SPACING_AFTER

See Also:

Constant Field Values

PROPERTY_TAB_STOP_WIDTH

public static final String PROPERTY_TAB_STOP_WIDTH

See Also:

Constant Field Values

PROPERTY_TAB_STOPS

public static final String PROPERTY_TAB_STOPS

See Also:

Constant Field Values

paragraphContainer

protected JRParagraphContainer paragraphContainer

lineSpacing

protected LineSpacingEnum lineSpacing

lineSpacingSize

protected Float lineSpacingSize

firstLineIndent

protected Integer firstLineIndent

leftIndent

protected Integer leftIndent

rightIndent

protected Integer rightIndent

spacingBefore

protected Integer spacingBefore

spacingAfter

protected Integer spacingAfter

tabStopWidth

protected Integer tabStopWidth

tabStops

protected List<TabStop> tabStops

Constructor Detail

JRBaseParagraph

public JRBaseParagraph(JRParagraphContainer paragraphContainer)

Method Detail

getDefaultStyleProvider

public JRDefaultStyleProvider getDefaultStyleProvider()

Specified by:

getDefaultStyleProvider in interface JRStyleContainer

getStyle

public JRStyle getStyle()

Description copied from interface: JRStyleContainer

Returns this object's style.

Specified by:

getStyle in interface JRStyleContainer

Returns:

this object's style

getStyleNameReference

public String getStyleNameReference()

Description copied from interface: JRStyleContainer

Returns the name of an external style which is to be used by this object.

External styles are defined in templates and are resolved at fill time. This attribute is only effective if no direct style (as returned by getStyle() is specified for this object.

Specified by:

getStyleNameReference in interface JRStyleContainer

Returns:

the name of an external style

getParagraphContainer

public JRParagraphContainer getParagraphContainer()

getLineSpacing

public LineSpacingEnum getLineSpacing()

Description copied from interface: JRParagraph

Gets the text line spacing.

Specified by:

getLineSpacing in interface JRParagraph

Returns:

a value representing one of the line spacing constants in LineSpacingEnum

getOwnLineSpacing

public LineSpacingEnum getOwnLineSpacing()

Description copied from interface: JRParagraph

Gets the text own line spacing.

Specified by:

getOwnLineSpacing in interface JRParagraph

Returns:

a value representing one of the line spacing constants in LineSpacingEnum

setLineSpacing

public void setLineSpacing(LineSpacingEnum lineSpacing)

Description copied from interface: JRParagraph

Sets the text line spacing.

Specified by:

setLineSpacing in interface JRParagraph

Parameters:

lineSpacing - a value representing one of the line spacing constants in LineSpacingEnum

getLineSpacingSize

public Float getLineSpacingSize()

Description copied from interface: JRParagraph

Gets the text line spacing size to be used in combination with the line spacing type.

Specified by:

getLineSpacingSize in interface JRParagraph

getOwnLineSpacingSize

public Float getOwnLineSpacingSize()

Description copied from interface: JRParagraph

Gets the text own line spacing size to be used in combination with the line spacing type.

Specified by:

getOwnLineSpacingSize in interface JRParagraph

setLineSpacingSize

public void setLineSpacingSize(Float lineSpacingSize)

Description copied from interface: JRParagraph

Sets the text line spacing size to be used in combination with the line spacing type.

Specified by:

setLineSpacingSize in interface JRParagraph

getFirstLineIndent

public Integer getFirstLineIndent()

Description copied from interface: JRParagraph

Gets the text first line indent.

Specified by:

getFirstLineIndent in interface JRParagraph

getOwnFirstLineIndent

public Integer getOwnFirstLineIndent()

Description copied from interface: JRParagraph

Gets the text own first line indent.

Specified by:

getOwnFirstLineIndent in interface JRParagraph

setFirstLineIndent

public void setFirstLineIndent(Integer firstLineIndent)

Description copied from interface: JRParagraph

Sets the text own first line indent.

Specified by:

setFirstLineIndent in interface JRParagraph

getLeftIndent

public Integer getLeftIndent()

Description copied from interface: JRParagraph

Gets the text left indent.

Specified by:

getLeftIndent in interface JRParagraph

getOwnLeftIndent

public Integer getOwnLeftIndent()

Description copied from interface: JRParagraph

Gets the text own left indent.

Specified by:

getOwnLeftIndent in interface JRParagraph

setLeftIndent

public void setLeftIndent(Integer leftIndent)

Description copied from interface: JRParagraph

Sets the text own left indent.

Specified by:

setLeftIndent in interface JRParagraph

getRightIndent

public Integer getRightIndent()

Description copied from interface: JRParagraph

Gets the text right indent.

Specified by:

getRightIndent in interface JRParagraph

getOwnRightIndent

public Integer getOwnRightIndent()

Description copied from interface: JRParagraph

Gets the text own right indent.

Specified by:

getOwnRightIndent in interface JRParagraph

setRightIndent

public void setRightIndent(Integer rightIndent)

Description copied from interface: JRParagraph

Sets the text own right indent.

Specified by:

setRightIndent in interface JRParagraph

getSpacingBefore

public Integer getSpacingBefore()

Description copied from interface: JRParagraph

Gets the text spacing before.

Specified by:

getSpacingBefore in interface JRParagraph

getOwnSpacingBefore

public Integer getOwnSpacingBefore()

Description copied from interface: JRParagraph

Gets the text own spacing before.

Specified by:

getOwnSpacingBefore in interface JRParagraph

setSpacingBefore

public void setSpacingBefore(Integer spacingBefore)

Description copied from interface: JRParagraph

Sets the text own spacing before.

Specified by:

setSpacingBefore in interface JRParagraph

getSpacingAfter

public Integer getSpacingAfter()

Description copied from interface: JRParagraph

Gets the text spacing after.

Specified by:

getSpacingAfter in interface JRParagraph

getOwnSpacingAfter

public Integer getOwnSpacingAfter()

Description copied from interface: JRParagraph

Gets the text own spacing after.

Specified by:

getOwnSpacingAfter in interface JRParagraph

setSpacingAfter

public void setSpacingAfter(Integer spacingAfter)

Description copied from interface: JRParagraph

Sets the text own spacing after.

Specified by:

setSpacingAfter in interface JRParagraph

getTabStopWidth

public Integer getTabStopWidth()

Description copied from interface: JRParagraph

Gets the text tab stop width.

Specified by:

getTabStopWidth in interface JRParagraph

getOwnTabStopWidth

public Integer getOwnTabStopWidth()

Description copied from interface: JRParagraph

Gets the text own tab stop width.

Specified by:

getOwnTabStopWidth in interface JRParagraph

setTabStopWidth

public void setTabStopWidth(Integer tabStopWidth)

Description copied from interface: JRParagraph

Sets the text own tab stop width.

Specified by:

setTabStopWidth in interface JRParagraph

getTabStops

public TabStop[] getTabStops()

Description copied from interface: JRParagraph

Gets the custom tab stops.

Specified by:

getTabStops in interface JRParagraph

getOwnTabStops

public TabStop[] getOwnTabStops()

Description copied from interface: JRParagraph

Gets the custom tab stops.

Specified by:

getOwnTabStops in interface JRParagraph

addTabStop

public void addTabStop(TabStop tabStop)

Specified by:

addTabStop in interface JRParagraph

addTabStop

public void addTabStop(int index,
              TabStop tabStop)

Specified by:

addTabStop in interface JRParagraph

removeTabStop

public void removeTabStop(TabStop tabStop)

Specified by:

removeTabStop in interface JRParagraph

removeTabStop

public void removeTabStop(int index)

Specified by:

removeTabStop in interface JRParagraph

clone

public JRParagraph clone(JRParagraphContainer paragraphContainer)

Specified by:

clone in interface JRParagraph

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance

getHashCode

public int getHashCode()

Description copied from interface: Deduplicable

Returns a hash code to be used for the deduplicate map. The returned hash code should be consitent wiwh Deduplicable.isIdentical(Object), i.e. if two objects are identical they should have the same hash code.

Specified by:

getHashCode in interface Deduplicable

Returns:

deduplication hash code

isIdentical

public boolean isIdentical(Object object)

Description copied from interface: Deduplicable

Determines if this instance is identical to another object.

Specified by:

isIdentical in interface Deduplicable

Parameters:

object - the object to compare with this instance

Returns:

true if the two objects are identical and can be deduplicated