Package net.sf.jasperreports.engine
Interface JRParagraph
-
- All Superinterfaces:
JRStyleContainer
- All Known Implementing Classes:
CachingParagraph
,JRBaseParagraph
public interface JRParagraph extends JRStyleContainer
- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_FIRST_LINE_INDENT
Specifies the default value (in pixels) for the first line indent, if no explicit information is provided in a JR paragraph.static String
DEFAULT_LEFT_INDENT
Specifies the default value (in pixels) for the left indent, if no explicit information is provided in a JR paragraph.static String
DEFAULT_LINE_SPACING_SIZE
Specifies the default value for the text line spacing size, if no explicit information is provided in a JR paragraph.static String
DEFAULT_RIGHT_INDENT
Specifies the default value (in pixels) for the right indent, if no explicit information is provided in a JR paragraph.static String
DEFAULT_SPACING_AFTER
Specifies the default value (in pixels) for the spacing after lines, if no explicit information is provided in a JR paragraph.static String
DEFAULT_SPACING_BEFORE
Specifies the default value (in pixels) for the spacing before lines, if no explicit information is provided in a JR paragraph.static String
DEFAULT_TAB_STOP_WIDTH
Specifies the default value (in pixels) for the tab stop width, if no explicit information is provided in a paragraph.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addTabStop(int index, TabStop tabStop)
void
addTabStop(TabStop tabStop)
JRParagraph
clone(JRParagraphContainer paragraphContainer)
Integer
getFirstLineIndent()
Gets the text first line indent.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()
Gets the text line spacing.Integer
getRightIndent()
Gets the text right indent.Integer
getSpacingAfter()
Gets the text spacing after.Integer
getSpacingBefore()
Gets the text spacing before.TabStop[]
getTabStops()
Gets the custom tab stops.Integer
getTabStopWidth()
Gets the text tab stop width.void
populateStyle()
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 interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference
-
-
-
-
Field Detail
-
DEFAULT_LINE_SPACING_SIZE
static final String DEFAULT_LINE_SPACING_SIZE
Specifies the default value for the text line spacing size, if no explicit information is provided in a JR paragraph. This value is used in combination with the size-dependent line spacings inLineSpacingEnum
:- AT_LEAST
- FIXED
- PROPORTIONAL
-
DEFAULT_FIRST_LINE_INDENT
static final String DEFAULT_FIRST_LINE_INDENT
Specifies the default value (in pixels) for the first line indent, if no explicit information is provided in a JR paragraph.
By default the first line in JR paragraphs has no indentation.- See Also:
- Constant Field Values
-
DEFAULT_LEFT_INDENT
static final String DEFAULT_LEFT_INDENT
Specifies the default value (in pixels) for the left indent, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no left indentation.- See Also:
- Constant Field Values
-
DEFAULT_RIGHT_INDENT
static final String DEFAULT_RIGHT_INDENT
Specifies the default value (in pixels) for the right indent, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no right indentation.- See Also:
- Constant Field Values
-
DEFAULT_SPACING_BEFORE
static final String DEFAULT_SPACING_BEFORE
Specifies the default value (in pixels) for the spacing before lines, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no spacing before lines.- See Also:
- Constant Field Values
-
DEFAULT_SPACING_AFTER
static final String DEFAULT_SPACING_AFTER
Specifies the default value (in pixels) for the spacing after lines, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no spacing after lines.- See Also:
- Constant Field Values
-
DEFAULT_TAB_STOP_WIDTH
static final String DEFAULT_TAB_STOP_WIDTH
Specifies the default value (in pixels) for the tab stop width, if no explicit information is provided in a paragraph.
By default JR paragraphs provide 40 pixels wide tab stops.- See Also:
- Constant Field Values
-
-
Method Detail
-
getParagraphContainer
JRParagraphContainer getParagraphContainer()
Gets the text line spacing.- Returns:
- a value representing one of the line spacing constants in
LineSpacingEnum
-
clone
JRParagraph clone(JRParagraphContainer paragraphContainer)
-
populateStyle
void populateStyle()
-
getLineSpacing
LineSpacingEnum getLineSpacing()
Gets the text line spacing.- Returns:
- a value representing one of the line spacing constants in
LineSpacingEnum
-
getOwnLineSpacing
LineSpacingEnum getOwnLineSpacing()
Gets the text own line spacing.- Returns:
- a value representing one of the line spacing constants in
LineSpacingEnum
-
setLineSpacing
void setLineSpacing(LineSpacingEnum lineSpacing)
Sets the text line spacing.- Parameters:
lineSpacing
- a value representing one of the line spacing constants inLineSpacingEnum
-
getLineSpacingSize
Float getLineSpacingSize()
Gets the text line spacing size to be used in combination with the line spacing type.
-
getOwnLineSpacingSize
Float getOwnLineSpacingSize()
Gets the text own line spacing size to be used in combination with the line spacing type.
-
setLineSpacingSize
void setLineSpacingSize(Float lineSpacingSize)
Sets the text line spacing size to be used in combination with the line spacing type.
-
getLeftIndent
Integer getLeftIndent()
Gets the text left indent.
-
getOwnLeftIndent
Integer getOwnLeftIndent()
Gets the text own left indent.
-
setLeftIndent
void setLeftIndent(Integer leftIndent)
Sets the text own left indent.
-
getFirstLineIndent
Integer getFirstLineIndent()
Gets the text first line indent.
-
getOwnFirstLineIndent
Integer getOwnFirstLineIndent()
Gets the text own first line indent.
-
setFirstLineIndent
void setFirstLineIndent(Integer firstLineIndent)
Sets the text own first line indent.
-
getRightIndent
Integer getRightIndent()
Gets the text right indent.
-
getOwnRightIndent
Integer getOwnRightIndent()
Gets the text own right indent.
-
setRightIndent
void setRightIndent(Integer rightIndent)
Sets the text own right indent.
-
getSpacingBefore
Integer getSpacingBefore()
Gets the text spacing before.
-
getOwnSpacingBefore
Integer getOwnSpacingBefore()
Gets the text own spacing before.
-
setSpacingBefore
void setSpacingBefore(Integer spacingBefore)
Sets the text own spacing before.
-
getSpacingAfter
Integer getSpacingAfter()
Gets the text spacing after.
-
getOwnSpacingAfter
Integer getOwnSpacingAfter()
Gets the text own spacing after.
-
setSpacingAfter
void setSpacingAfter(Integer spacingAfter)
Sets the text own spacing after.
-
getTabStopWidth
Integer getTabStopWidth()
Gets the text tab stop width.
-
getOwnTabStopWidth
Integer getOwnTabStopWidth()
Gets the text own tab stop width.
-
setTabStopWidth
void setTabStopWidth(Integer tabStopWidth)
Sets the text own tab stop width.
-
getTabStops
TabStop[] getTabStops()
Gets the custom tab stops.
-
getOwnTabStops
TabStop[] getOwnTabStops()
Gets the custom tab stops.
-
addTabStop
void addTabStop(TabStop tabStop)
-
addTabStop
void addTabStop(int index, TabStop tabStop)
-
removeTabStop
void removeTabStop(int index)
-
removeTabStop
void removeTabStop(TabStop tabStop)
-
-