sos.reports
Class ReportStyleConstants

java.lang.Object
  |
  +--sos.reports.ReportStyleConstants

Direct Known Subclasses:

ReportStyleConstants.ObjectConstants, ReportStyleConstants.TableConstants

public class ReportStyleConstants

extends java.lang.Object

A collection of report attributes keys beyond those defined by javax.swing.text.StyleConstants. The methods defined in this class are typesafe convenience methods for setting and retrieving report attributes.

Key	Meaning	Values	Default Value	Inherited?	Used By
AllCaps	Characters appear in uppercase	Boolean	FALSE	Y	Object
AutoFit	Text is sized so that it fits in its container	Boolean	FALSE	Y	Object
BackgroundFill	The background coloring	Fill	NONE	N	All
BorderFill	The coloring of the left, right, top, and bottom border	Fill	BLACK	N	All
BorderThickness	The thickness of the left, right, top, and bottom border	Float	0.0	N	All
BottomBorderFill	The coloring of the bottom border	Fill	BLACK	N	All
BottomBorderThickness	The thickness of the bottom border	Float	0.0	N	All
BottomPadding	The bottom margin	Float	0.0	N	All
ColumnCushionAfter	Padding after a column	Float	0.0	N	Table
ColumnCushionBefore	Padding before a column	Float	0.0	N	Table
FillProportion	Proportion of remaining amount to assume	Integer	1	N	Table
Format	Object that converts an object to text	Format	DEFAULT_FORMAT	N	Object
HorizontalAlignment	The horizontal alignment of cell contents	ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_JUSTIFIED	FULL	Y	Cell
HorizontalGridFill	The coloring of horizontal grid lines	Fill	BLACK	N	Table
HorizontalGridThickness	The thickness of horizontal grid lines	Float	0.0	N	Table
KeptTogetherHorizontally	Do not allow a page break horizontally	Boolean	F	N	All
KeptTogetherVertically	Do not allow a page break vertically	Boolean	F	N	All
KeptWithNext	Do not break between this tier and the next tier	Boolean	F	N	Tier
KeptWithPrevious	Do not break between the previous tier and this tier	Boolean	F	N	Tier
LeftBorderFill	The coloring of the left border	Fill	BLACK	N	All
LeftBorderThickness	The thickness of the left border	Float	0.0	N	All
LeftPadding	The left margin	Float	0.0	N	All
MinimumHeight	Element wishes to be as tall as this value	Float	0.0	N	All
MinimumWidth	Element wishes to be as wide as this value	Float	0.0	N	All
OrphanColumnCount	Minimum number of columns before a page break is allowed	Integer	0	N	Table
OrphanRowCount	Minimum number of rows before a page break is allowed	Integer	2	N	Table
Padding	The left, right, top, and bottom margins	Float	0.0	N	All
PageBreak	Force a page break before an element	Boolean	F	N	Tier
Renderer	Object that renders an element	ElementRenderer	null	Y	Object
ReportTemplate	Template that should be used for a nested report	ReportTemplate	null	Y	Object
RightBorderFill	The coloring of the right border	Fill	BLACK	N	All
RightBorderThickness	The thickness of the right border	Float	0.0	N	All
RightPadding	The right margin	Float	0.0	N	All
Rotation	The angle of text rotation (in radians)	Double	0.0	Y	Object
RowCushionAfter	Padding after a row	Float	0.0	N	Table
RowCushionBefore	Padding before a row	Float	0.0	N	Table
TableFormat	The table format	TableFormat	null	N	Table
Theme	The appearance of the nested report	Theme	null	N	Object
ToolTip	Text that appears when the mouse is over the element	String	null	N	All
TopBorderFill	The coloring of the top border	Fill	BLACK	N	All
TopBorderThickness	The thickness of the top border	Float	0.0	N	All
TopPadding	The top margin	Float	0.0	N	All
VerticalAlignment	The vertical alignment of cell contents	ALIGN_TOP, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED	FULL	Y	Cell
VerticalGridFill	The coloring of vertical grid lines	Fill	BLACK	N	Table
VerticalGridThickness	The thickness of vertical grid lines	Float	0.0	N	Table
WidowColumnCount	Minimum number of columns after a page break	Integer	0	N	Table
WidowRowCount	Minimum number of rows after a page break	Integer	2	N	Table
Wrapped	Allows text to wrap in its container	Boolean	F	Y	Object

Since:

1.0

See Also:

Fill, TableFormat

Nested Class Summary

static class	ReportStyleConstants.ObjectConstants A typesafe enumeration of attributes that contribute to the visualization of an object.
static class	ReportStyleConstants.TableConstants A typesafe enumeration of attributes that contribute to the visualization of a table.

Field Summary

static int	ALIGN_BOTTOM Indicates that the component is bottom justified in its cell
static int	ALIGN_TOP Indicates that the component is top justified in its cell
static java.lang.Object	AllCaps The style key for text to be entirely in capital letters.
static java.lang.Object	AutoFit The style key for text to be automatically sized to fit its container.
static java.lang.Object	BackgroundFill The style key for the background fill.
static java.lang.Object	BorderFill The style key for the left, right, top, and bottom border fill.
static java.lang.Object	BorderThickness The style key for the left, right, top, and bottom border thickness.
static java.lang.Object	BottomBorderFill The style key for the bottom border fill.
static java.lang.Object	BottomBorderThickness The style key for the bottom border thickness.
static java.lang.Object	BottomPadding The style key for a container's bottom margin.
static java.lang.Object	ColumnCushionAfter The style key for the amount of space after interior columns.
static java.lang.Object	ColumnCushionBefore The style key for the amount of space before interior columns.
static java.text.Format	DEFAULT_FORMAT An object that invokes an object's toString method to convert it to text.
static java.lang.Object	FillProportion The style key for the relative amount of excess space that a tier wishes to assume.
static java.lang.Object	Format The style key for converting an object to text.
static java.lang.Object	HorizontalAlignment The style key for the horizontal alignment of cell contents.
static java.lang.Object	HorizontalGridFill The style key for the fill of a table's horizontal grid lines.
static java.lang.Object	HorizontalGridThickness The style key for the height of a table's horizontal grid lines.
static java.lang.Object	KeptTogetherHorizontally The style key for an element's inability to be broken horizontally.
static java.lang.Object	KeptTogetherVertically The style key for an element's inability to be broken vertically.
static java.lang.Object	KeptWithNext The style key for a tier's desire to be on the same page with the next tier.
static java.lang.Object	KeptWithPrevious The style key for a tier's desire to be on the same page with the previous tier.
static java.lang.Object	LeftBorderFill The style key for the left border fill.
static java.lang.Object	LeftBorderThickness The style key for the left border thickness.
static java.lang.Object	LeftPadding The style key for a container's left margin.
static java.lang.Object	MinimumHeight The style key for an object's minimum height.
static java.lang.Object	MinimumWidth The style key for an object's minimum width.
static java.lang.Object	OrphanColumnCount The style key for the number of columns needed before a page break.
static java.lang.Object	OrphanRowCount The style key for the number of rows needed before a page break.
static java.lang.Object	Padding The style key for the left, right, top, and bottom margins.
static java.lang.Object	PageBreak The style key for a tier's desire to be on the next page.
static java.lang.Object	Renderer The style key for an object renderer.
static java.lang.Object	ReportTemplate The style key for the template to use for a nested report.
static java.lang.Object	RightBorderFill The style key for the right border fill.
static java.lang.Object	RightBorderThickness The style key for the right border thickness.
static java.lang.Object	RightPadding The style key for a container's right margin.
static java.lang.Object	Rotation The style key for text rotation.
static java.lang.Object	RowCushionAfter The style key for the amount of space after interior rows.
static java.lang.Object	RowCushionBefore The style key for the amount of space before interior rows.
static java.lang.Object	TableFormat The style key for the table format.
static java.lang.Object	Theme The style key for the theme to use for a nested report.
static java.lang.Object	ToolTip The style key for the tool tip.
static java.lang.Object	TopBorderFill The style key for the top border fill.
static java.lang.Object	TopBorderThickness The style key for the top border thickness.
static java.lang.Object	TopPadding The style key for a container's top margin.
static java.lang.Object	VerticalAlignment The style key for the vertical alignment of cell contents.
static java.lang.Object	VerticalGridFill The style key for the fill of a table's vertical grid lines.
static java.lang.Object	VerticalGridThickness The style key for the height of a table's vertical grid lines.
static java.lang.Object	WidowColumnCount The style key for the number of columns needed after a page break.
static java.lang.Object	WidowRowCount The style key for the number of rows needed after a page break.
static java.lang.Object	Wrapped The style key for wrapping text in its container.

Method Summary

static Fill	getBackgroundFill(javax.swing.text.AttributeSet a) Returns the background coloring specification.
static Fill	getBorderFill(javax.swing.text.AttributeSet a) Returns the left, right, top, and bottom border coloring specification.
static double	getBorderThickness(javax.swing.text.AttributeSet a) Returns the thickness of the left, right, top, and bottom border.
static Fill	getBottomBorderFill(javax.swing.text.AttributeSet a) Returns the bottom border coloring specification.
static double	getBottomBorderThickness(javax.swing.text.AttributeSet a) Returns the height of the bottom border.
static double	getBottomPadding(javax.swing.text.AttributeSet a) Returns the bottom margin.
static double	getColumnCushionAfter(javax.swing.text.AttributeSet a) Returns the amount of space after interior columns.
static double	getColumnCushionBefore(javax.swing.text.AttributeSet a) Returns the amount of space before interior columns.
static int	getFillProportion(javax.swing.text.AttributeSet a) Returns the relative amount of excess space that a tier wishes to assume.
static java.text.Format	getFormat(javax.swing.text.AttributeSet a) Returns the Format object that converts an object to text.
static int	getHorizontalAlignment(javax.swing.text.AttributeSet a) Returns the horizontal alignment of cell contents.
static Fill	getHorizontalGridFill(javax.swing.text.AttributeSet a) Returns the coloring specification of horizontal grid lines.
static double	getHorizontalGridThickness(javax.swing.text.AttributeSet a) Returns the height of horizontal grid lines.
static Fill	getLeftBorderFill(javax.swing.text.AttributeSet a) Returns the left border coloring specification.
static double	getLeftBorderThickness(javax.swing.text.AttributeSet a) Returns the width of the left border.
static double	getLeftPadding(javax.swing.text.AttributeSet a) Returns the left margin.
static double	getMinimumHeight(javax.swing.text.AttributeSet a) Returns the minimum height.
static double	getMinimumWidth(javax.swing.text.AttributeSet a) Returns the minimum width.
static int	getOrphanColumnCount(javax.swing.text.AttributeSet a) Returns the minimum number of columns before a page break is allowed.
static int	getOrphanRowCount(javax.swing.text.AttributeSet a) Returns the minimum number of rows before a page break is allowed.
static double	getPadding(javax.swing.text.AttributeSet a) Returns the left, right, top, and bottom margin.
static ElementRenderer	getRenderer(javax.swing.text.AttributeSet a) Returns the renderer to use to display an element.
static ReportTemplate	getReportTemplate(javax.swing.text.AttributeSet a) Returns the report template to use for a nested report.
static Fill	getRightBorderFill(javax.swing.text.AttributeSet a) Returns the right border coloring specification.
static double	getRightBorderThickness(javax.swing.text.AttributeSet a) Returns the width of the right border.
static double	getRightPadding(javax.swing.text.AttributeSet a) Returns the right margin.
static double	getRotation(javax.swing.text.AttributeSet a) Returns the text rotation setting.
static double	getRowCushionAfter(javax.swing.text.AttributeSet a) Returns the amount of space after interior rows.
static double	getRowCushionBefore(javax.swing.text.AttributeSet a) Returns the amount of space before interior rows.
static TableFormat	getTableFormat(javax.swing.text.AttributeSet a) Returns the table format setting.
static Theme	getTheme(javax.swing.text.AttributeSet a) Returns the theme to use for a nested report.
static java.lang.String	getToolTip(javax.swing.text.AttributeSet a) Returns the tool tip.
static Fill	getTopBorderFill(javax.swing.text.AttributeSet a) Returns the top border coloring specification.
static double	getTopBorderThickness(javax.swing.text.AttributeSet a) Returns the height of the top border.
static double	getTopPadding(javax.swing.text.AttributeSet a) Returns the top margin.
static int	getVerticalAlignment(javax.swing.text.AttributeSet a) Returns the vertical alignment of cell contents.
static Fill	getVerticalGridFill(javax.swing.text.AttributeSet a) Returns the coloring specification of vertical grid lines.
static double	getVerticalGridThickness(javax.swing.text.AttributeSet a) Returns the width of vertical grid lines.
static int	getWidowColumnCount(javax.swing.text.AttributeSet a) Returns the minimum number of columns needed after a page break.
static int	getWidowRowCount(javax.swing.text.AttributeSet a) Returns the minimum number of rows needed after a page break.
static boolean	isAllCaps(javax.swing.text.AttributeSet a) Returns the all caps setting.
static boolean	isAttributeInherited(java.lang.Object attribute) Returns true if the specified attribute is known to be inherited.
static boolean	isAutoFit(javax.swing.text.AttributeSet a) Returns the auto fit setting.
static boolean	isKeptTogetherHorizontally(javax.swing.text.AttributeSet a) Returns true if the element should not be broken horizontally.
static boolean	isKeptTogetherVertically(javax.swing.text.AttributeSet a) Returns true if the element should not be broken vertically.
static boolean	isKeptWithNext(javax.swing.text.AttributeSet a) Returns true if the tier should be on the same page as the next tier.
static boolean	isKeptWithPrevious(javax.swing.text.AttributeSet a) Returns true if the tier should be on the same page as the previous tier.
static boolean	isPageBreak(javax.swing.text.AttributeSet a) Returns true if a page break is desired.
static boolean	isWrapped(javax.swing.text.AttributeSet a) Returns true if text is allowed to wrap.
static void	setAllCaps(javax.swing.text.MutableAttributeSet a, boolean b) Sets whether or not text should be in all capital letters.
static void	setAutoFit(javax.swing.text.MutableAttributeSet a, boolean b) Sets whether or not text should be sized to fit its container.
static void	setBackgroundFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the background coloring specification.
static void	setBorderFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the coloring specification of the left, right, top, and bottom border.
static void	setBorderThickness(javax.swing.text.MutableAttributeSet a, double thickness) Sets the thickness of the left, right, top, and bottom border.
static void	setBottomBorderFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the coloring specification of the bottom border.
static void	setBottomBorderThickness(javax.swing.text.MutableAttributeSet a, double thickness) Sets the height of the bottom border.
static void	setBottomPadding(javax.swing.text.MutableAttributeSet a, double padding) Sets the bottom padding.
static void	setColumnCushionAfter(javax.swing.text.MutableAttributeSet a, double cushion) Sets the amount of space after interior columns.
static void	setColumnCushionBefore(javax.swing.text.MutableAttributeSet a, double cushion) Sets the amount of space before interior columns.
static void	setFillProportion(javax.swing.text.MutableAttributeSet a, int fillProportion) Sets the relative amount of excess space that a tier wishes to assume.
static void	setFormat(javax.swing.text.MutableAttributeSet a, java.text.Format format) Sets the object that converts objects to text.
static void	setHorizontalAlignment(javax.swing.text.MutableAttributeSet a, int alignment) Sets the horizontal alignment of cell contents.
static void	setHorizontalGridFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the coloring specification of horizontal grid lines.
static void	setHorizontalGridThickness(javax.swing.text.MutableAttributeSet a, double thickness) Sets the height of horizontal grid lines.
static void	setKeptTogetherHorizontally(javax.swing.text.MutableAttributeSet a, boolean b) Sets an element's inability to be broken horizontally.
static void	setKeptTogetherVertically(javax.swing.text.MutableAttributeSet a, boolean b) Sets an element's inability to be broken vertically.
static void	setKeptWithNext(javax.swing.text.MutableAttributeSet a, boolean b) Sets a tier's desire to be on the same page with the next tier.
static void	setKeptWithPrevious(javax.swing.text.MutableAttributeSet a, boolean b) Sets a tier's desire to be on the same page with the previous tier.
static void	setLeftBorderFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the coloring specification of the left border.
static void	setLeftBorderThickness(javax.swing.text.MutableAttributeSet a, double thickness) Sets the width of the left border.
static void	setLeftPadding(javax.swing.text.MutableAttributeSet a, double padding) Sets the left padding.
static void	setMinimumHeight(javax.swing.text.MutableAttributeSet a, double height) Sets the minimum height.
static void	setMinimumWidth(javax.swing.text.MutableAttributeSet a, double width) Sets the minimum width.
static void	setOrphanColumnCount(javax.swing.text.MutableAttributeSet a, int orphanCount) Sets the minimum number of columns before a page break is allowed.
static void	setOrphanRowCount(javax.swing.text.MutableAttributeSet a, int orphanCount) Sets the minimum number of rows before a page break is allowed.
static void	setPadding(javax.swing.text.MutableAttributeSet a, double padding) Sets the left, right, top, and bottom margins.
static void	setPageBreak(javax.swing.text.MutableAttributeSet a, boolean b) Sets a tier's desire to be on the next page.
static void	setRenderer(javax.swing.text.MutableAttributeSet a, ElementRenderer renderer) Sets the renderer to use to display an element.
static void	setReportTemplate(javax.swing.text.MutableAttributeSet a, ReportTemplate reportTemplate) Sets the report template to use for a nested report.
static void	setRightBorderFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the coloring specification of the right border.
static void	setRightBorderThickness(javax.swing.text.MutableAttributeSet a, double thickness) Sets the width of the right border.
static void	setRightPadding(javax.swing.text.MutableAttributeSet a, double padding) Sets the right padding.
static void	setRotation(javax.swing.text.MutableAttributeSet a, double rotation) Sets the rotation (in radians).
static void	setRowCushionAfter(javax.swing.text.MutableAttributeSet a, double cushion) Sets the amount of space after interior rows.
static void	setRowCushionBefore(javax.swing.text.MutableAttributeSet a, double cushion) Sets the amount of space before interior rows.
static void	setTableFormat(javax.swing.text.MutableAttributeSet a, TableFormat tableFormat) Sets the table format.
static void	setTheme(javax.swing.text.MutableAttributeSet a, Theme theme) Sets the theme to use for a nested report.
static void	setToolTip(javax.swing.text.MutableAttributeSet a, java.lang.String toolTip) Sets the tool tip.
static void	setTopBorderFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the coloring specification of the top border.
static void	setTopBorderThickness(javax.swing.text.MutableAttributeSet a, double thickness) Sets the height of the top border.
static void	setTopPadding(javax.swing.text.MutableAttributeSet a, double padding) Sets the top padding.
static void	setVerticalAlignment(javax.swing.text.MutableAttributeSet a, int alignment) Sets the vertical alignment of cell contents.
static void	setVerticalGridFill(javax.swing.text.MutableAttributeSet a, Fill fill) Sets the coloring specification of vertical grid lines.
static void	setVerticalGridThickness(javax.swing.text.MutableAttributeSet a, double thickness) Sets the height of vertical grid lines.
static void	setWidowColumnCount(javax.swing.text.MutableAttributeSet a, int widowCount) Sets the minimum number of columns needed after a page break.
static void	setWidowRowCount(javax.swing.text.MutableAttributeSet a, int widowCount) Sets the minimum number of rows needed after a page break.
static void	setWrapped(javax.swing.text.MutableAttributeSet a, boolean b) Sets whether or not text is allowed to wrap.
java.lang.String	toString() Returns the string representation.

Methods inherited from class java.lang.Object

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

Field Detail

ALIGN_TOP

public static final int ALIGN_TOP

Indicates that the component is top justified in its cell

See Also:

Constant Field Values

ALIGN_BOTTOM

public static final int ALIGN_BOTTOM

Indicates that the component is bottom justified in its cell

See Also:

Constant Field Values

AllCaps

public static final java.lang.Object AllCaps

The style key for text to be entirely in capital letters.

See Also:

isAllCaps(javax.swing.text.AttributeSet), setAllCaps(javax.swing.text.MutableAttributeSet, boolean)

AutoFit

public static final java.lang.Object AutoFit

The style key for text to be automatically sized to fit its container.

See Also:

isAutoFit(javax.swing.text.AttributeSet), setAutoFit(javax.swing.text.MutableAttributeSet, boolean)

BackgroundFill

public static final java.lang.Object BackgroundFill

The style key for the background fill.

See Also:

getBackgroundFill(javax.swing.text.AttributeSet), setBackgroundFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

BorderFill

public static final java.lang.Object BorderFill

The style key for the left, right, top, and bottom border fill.

See Also:

getBorderFill(javax.swing.text.AttributeSet), setBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

BorderThickness

public static final java.lang.Object BorderThickness

The style key for the left, right, top, and bottom border thickness.

See Also:

getBorderThickness(javax.swing.text.AttributeSet), setBorderThickness(javax.swing.text.MutableAttributeSet, double)

BottomBorderFill

public static final java.lang.Object BottomBorderFill

The style key for the bottom border fill.

See Also:

getBottomBorderFill(javax.swing.text.AttributeSet), setBottomBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

BottomBorderThickness

public static final java.lang.Object BottomBorderThickness

The style key for the bottom border thickness.

See Also:

getBottomBorderThickness(javax.swing.text.AttributeSet), setBottomBorderThickness(javax.swing.text.MutableAttributeSet, double)

LeftBorderFill

public static final java.lang.Object LeftBorderFill

The style key for the left border fill.

See Also:

getLeftBorderFill(javax.swing.text.AttributeSet), setLeftBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

LeftBorderThickness

public static final java.lang.Object LeftBorderThickness

The style key for the left border thickness.

See Also:

getLeftBorderThickness(javax.swing.text.AttributeSet), setLeftBorderThickness(javax.swing.text.MutableAttributeSet, double)

RightBorderFill

public static final java.lang.Object RightBorderFill

The style key for the right border fill.

See Also:

getRightBorderFill(javax.swing.text.AttributeSet), setRightBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

RightBorderThickness

public static final java.lang.Object RightBorderThickness

The style key for the right border thickness.

See Also:

getRightBorderThickness(javax.swing.text.AttributeSet), setRightBorderThickness(javax.swing.text.MutableAttributeSet, double)

TopBorderFill

public static final java.lang.Object TopBorderFill

The style key for the top border fill.

See Also:

getTopBorderFill(javax.swing.text.AttributeSet), setTopBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

TopBorderThickness

public static final java.lang.Object TopBorderThickness

The style key for the top border thickness.

See Also:

getTopBorderThickness(javax.swing.text.AttributeSet), setTopBorderThickness(javax.swing.text.MutableAttributeSet, double)

Format

public static final java.lang.Object Format

The style key for converting an object to text.

See Also:

getFormat(javax.swing.text.AttributeSet), setFormat(javax.swing.text.MutableAttributeSet, java.text.Format)

Padding

public static final java.lang.Object Padding

The style key for the left, right, top, and bottom margins.

See Also:

getPadding(javax.swing.text.AttributeSet), setPadding(javax.swing.text.MutableAttributeSet, double)

LeftPadding

public static final java.lang.Object LeftPadding

The style key for a container's left margin.

See Also:

getLeftPadding(javax.swing.text.AttributeSet), setLeftPadding(javax.swing.text.MutableAttributeSet, double)

RightPadding

public static final java.lang.Object RightPadding

The style key for a container's right margin.

See Also:

getRightPadding(javax.swing.text.AttributeSet), setRightPadding(javax.swing.text.MutableAttributeSet, double)

TopPadding

public static final java.lang.Object TopPadding

The style key for a container's top margin.

See Also:

getTopPadding(javax.swing.text.AttributeSet), setTopPadding(javax.swing.text.MutableAttributeSet, double)

BottomPadding

public static final java.lang.Object BottomPadding

The style key for a container's bottom margin.

See Also:

getBottomPadding(javax.swing.text.AttributeSet), setBottomPadding(javax.swing.text.MutableAttributeSet, double)

HorizontalGridFill

public static final java.lang.Object HorizontalGridFill

The style key for the fill of a table's horizontal grid lines.

See Also:

getHorizontalGridFill(javax.swing.text.AttributeSet), setHorizontalGridFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

HorizontalGridThickness

public static final java.lang.Object HorizontalGridThickness

The style key for the height of a table's horizontal grid lines.

See Also:

getHorizontalGridThickness(javax.swing.text.AttributeSet), setHorizontalGridThickness(javax.swing.text.MutableAttributeSet, double)

VerticalGridFill

public static final java.lang.Object VerticalGridFill

The style key for the fill of a table's vertical grid lines.

See Also:

getVerticalGridFill(javax.swing.text.AttributeSet), setVerticalGridFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

VerticalGridThickness

public static final java.lang.Object VerticalGridThickness

The style key for the height of a table's vertical grid lines.

See Also:

getVerticalGridThickness(javax.swing.text.AttributeSet), setVerticalGridThickness(javax.swing.text.MutableAttributeSet, double)

ColumnCushionBefore

public static final java.lang.Object ColumnCushionBefore

The style key for the amount of space before interior columns.

See Also:

getColumnCushionBefore(javax.swing.text.AttributeSet), setColumnCushionBefore(javax.swing.text.MutableAttributeSet, double)

ColumnCushionAfter

public static final java.lang.Object ColumnCushionAfter

The style key for the amount of space after interior columns.

See Also:

getColumnCushionAfter(javax.swing.text.AttributeSet), setColumnCushionAfter(javax.swing.text.MutableAttributeSet, double)

RowCushionBefore

public static final java.lang.Object RowCushionBefore

The style key for the amount of space before interior rows.

See Also:

getRowCushionBefore(javax.swing.text.AttributeSet), setRowCushionBefore(javax.swing.text.MutableAttributeSet, double)

RowCushionAfter

public static final java.lang.Object RowCushionAfter

The style key for the amount of space after interior rows.

See Also:

getRowCushionAfter(javax.swing.text.AttributeSet), setRowCushionAfter(javax.swing.text.MutableAttributeSet, double)

FillProportion

public static final java.lang.Object FillProportion

The style key for the relative amount of excess space that a tier wishes to assume.

See Also:

getFillProportion(javax.swing.text.AttributeSet), setFillProportion(javax.swing.text.MutableAttributeSet, int)

HorizontalAlignment

public static final java.lang.Object HorizontalAlignment

The style key for the horizontal alignment of cell contents.

See Also:

getHorizontalAlignment(javax.swing.text.AttributeSet), setHorizontalAlignment(javax.swing.text.MutableAttributeSet, int)

KeptTogetherHorizontally

public static final java.lang.Object KeptTogetherHorizontally

The style key for an element's inability to be broken horizontally.

See Also:

isKeptTogetherHorizontally(javax.swing.text.AttributeSet), setKeptTogetherHorizontally(javax.swing.text.MutableAttributeSet, boolean)

KeptTogetherVertically

public static final java.lang.Object KeptTogetherVertically

The style key for an element's inability to be broken vertically.

See Also:

isKeptTogetherVertically(javax.swing.text.AttributeSet), setKeptTogetherVertically(javax.swing.text.MutableAttributeSet, boolean)

KeptWithNext

public static final java.lang.Object KeptWithNext

The style key for a tier's desire to be on the same page with the next tier.

See Also:

isKeptWithNext(javax.swing.text.AttributeSet), setKeptWithNext(javax.swing.text.MutableAttributeSet, boolean)

KeptWithPrevious

public static final java.lang.Object KeptWithPrevious

The style key for a tier's desire to be on the same page with the previous tier.

See Also:

isKeptWithPrevious(javax.swing.text.AttributeSet), setKeptWithPrevious(javax.swing.text.MutableAttributeSet, boolean)

MinimumHeight

public static final java.lang.Object MinimumHeight

The style key for an object's minimum height.

See Also:

getMinimumHeight(javax.swing.text.AttributeSet), setMinimumHeight(javax.swing.text.MutableAttributeSet, double)

MinimumWidth

public static final java.lang.Object MinimumWidth

The style key for an object's minimum width.

See Also:

getMinimumWidth(javax.swing.text.AttributeSet), setMinimumWidth(javax.swing.text.MutableAttributeSet, double)

OrphanColumnCount

public static final java.lang.Object OrphanColumnCount

The style key for the number of columns needed before a page break.

See Also:

getOrphanColumnCount(javax.swing.text.AttributeSet), setOrphanColumnCount(javax.swing.text.MutableAttributeSet, int)

OrphanRowCount

public static final java.lang.Object OrphanRowCount

The style key for the number of rows needed before a page break.

See Also:

getOrphanRowCount(javax.swing.text.AttributeSet), setOrphanRowCount(javax.swing.text.MutableAttributeSet, int)

PageBreak

public static final java.lang.Object PageBreak

The style key for a tier's desire to be on the next page.

See Also:

isPageBreak(javax.swing.text.AttributeSet), setPageBreak(javax.swing.text.MutableAttributeSet, boolean)

Renderer

public static final java.lang.Object Renderer

The style key for an object renderer.

See Also:

getRenderer(javax.swing.text.AttributeSet), setRenderer(javax.swing.text.MutableAttributeSet, sos.reports.ElementRenderer)

ReportTemplate

public static final java.lang.Object ReportTemplate

The style key for the template to use for a nested report.

See Also:

getReportTemplate(javax.swing.text.AttributeSet), setReportTemplate(javax.swing.text.MutableAttributeSet, sos.reports.ReportTemplate)

TableFormat

public static final java.lang.Object TableFormat

The style key for the table format.

See Also:

getTableFormat(javax.swing.text.AttributeSet), setTableFormat(javax.swing.text.MutableAttributeSet, sos.reports.TableFormat)

Rotation

public static final java.lang.Object Rotation

The style key for text rotation.

See Also:

getRotation(javax.swing.text.AttributeSet), setRotation(javax.swing.text.MutableAttributeSet, double)

Theme

public static final java.lang.Object Theme

The style key for the theme to use for a nested report.

See Also:

getTheme(javax.swing.text.AttributeSet), setTheme(javax.swing.text.MutableAttributeSet, sos.reports.Theme)

ToolTip

public static final java.lang.Object ToolTip

The style key for the tool tip.

See Also:

getToolTip(javax.swing.text.AttributeSet), setToolTip(javax.swing.text.MutableAttributeSet, java.lang.String)

VerticalAlignment

public static final java.lang.Object VerticalAlignment

The style key for the vertical alignment of cell contents.

See Also:

getVerticalAlignment(javax.swing.text.AttributeSet), setVerticalAlignment(javax.swing.text.MutableAttributeSet, int)

WidowColumnCount

public static final java.lang.Object WidowColumnCount

The style key for the number of columns needed after a page break.

See Also:

getWidowColumnCount(javax.swing.text.AttributeSet), setWidowColumnCount(javax.swing.text.MutableAttributeSet, int)

WidowRowCount

public static final java.lang.Object WidowRowCount

The style key for the number of rows needed after a page break.

See Also:

getWidowRowCount(javax.swing.text.AttributeSet), setWidowRowCount(javax.swing.text.MutableAttributeSet, int)

Wrapped

public static final java.lang.Object Wrapped

The style key for wrapping text in its container.

See Also:

isWrapped(javax.swing.text.AttributeSet), setWrapped(javax.swing.text.MutableAttributeSet, boolean)

DEFAULT_FORMAT

public static final java.text.Format DEFAULT_FORMAT

An object that invokes an object's toString method to convert it to text.

Method Detail

getBackgroundFill

public static Fill getBackgroundFill(javax.swing.text.AttributeSet a)

Returns the background coloring specification.

Parameters:

a - the attribute set

Returns:

the background fill

See Also:

setBackgroundFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getBorderFill

public static Fill getBorderFill(javax.swing.text.AttributeSet a)

Returns the left, right, top, and bottom border coloring specification.

Parameters:

a - the attribute set

Returns:

the border fill or Fill.BLACK, if not defined

See Also:

setBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getBorderThickness

public static double getBorderThickness(javax.swing.text.AttributeSet a)

Returns the thickness of the left, right, top, and bottom border.

Parameters:

a - the attribute set

Returns:

the border thickness or 0.0, if not defined

See Also:

setBorderThickness(javax.swing.text.MutableAttributeSet, double)

getBottomBorderFill

public static Fill getBottomBorderFill(javax.swing.text.AttributeSet a)

Returns the bottom border coloring specification.

Parameters:

a - the attribute set

Returns:

the bottom border fill or Fill.BLACK, if not defined

See Also:

setBottomBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getBottomBorderThickness

public static double getBottomBorderThickness(javax.swing.text.AttributeSet a)

Returns the height of the bottom border.

Parameters:

a - the attribute set

Returns:

the bottom border thickness or 0.0, if not defined

See Also:

setBottomBorderThickness(javax.swing.text.MutableAttributeSet, double)

getLeftBorderFill

public static Fill getLeftBorderFill(javax.swing.text.AttributeSet a)

Returns the left border coloring specification.

Parameters:

a - the attribute set

Returns:

the left border fill or Fill.BLACK, if not defined

See Also:

setLeftBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getLeftBorderThickness

public static double getLeftBorderThickness(javax.swing.text.AttributeSet a)

Returns the width of the left border.

Parameters:

a - the attribute set

Returns:

the left border thickness or 0.0, if not defined

See Also:

setLeftBorderThickness(javax.swing.text.MutableAttributeSet, double)

getRightBorderFill

public static Fill getRightBorderFill(javax.swing.text.AttributeSet a)

Returns the right border coloring specification.

Parameters:

a - the attribute set

Returns:

the right border fill or Fill.BLACK, if not defined

See Also:

setRightBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getRightBorderThickness

public static double getRightBorderThickness(javax.swing.text.AttributeSet a)

Returns the width of the right border.

Parameters:

a - the attribute set

Returns:

the right border thickness or 0.0, if not defined

See Also:

setRightBorderThickness(javax.swing.text.MutableAttributeSet, double)

getTopBorderFill

public static Fill getTopBorderFill(javax.swing.text.AttributeSet a)

Returns the top border coloring specification.

Parameters:

a - the attribute set

Returns:

the top border fill or Fill.BLACK, if not defined

See Also:

setTopBorderFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getTopBorderThickness

public static double getTopBorderThickness(javax.swing.text.AttributeSet a)

Returns the height of the top border.

Parameters:

a - the attribute set

Returns:

the top border thickness or 0.0, if not defined

See Also:

setTopBorderThickness(javax.swing.text.MutableAttributeSet, double)

getToolTip

public static java.lang.String getToolTip(javax.swing.text.AttributeSet a)

Returns the tool tip.

Parameters:

a - the attribute set

Returns:

the tool tip or null, if not defined

See Also:

setToolTip(javax.swing.text.MutableAttributeSet, java.lang.String)

getColumnCushionAfter

public static double getColumnCushionAfter(javax.swing.text.AttributeSet a)

Returns the amount of space after interior columns.

Parameters:

a - the attribute set

Returns:

the gap after columns or 0.0, if not defined

See Also:

setColumnCushionAfter(javax.swing.text.MutableAttributeSet, double)

getColumnCushionBefore

public static double getColumnCushionBefore(javax.swing.text.AttributeSet a)

Returns the amount of space before interior columns.

Parameters:

a - the attribute set

Returns:

the gap before columns or 0.0, if not defined

See Also:

setColumnCushionBefore(javax.swing.text.MutableAttributeSet, double)

getFillProportion

public static int getFillProportion(javax.swing.text.AttributeSet a)

Returns the relative amount of excess space that a tier wishes to assume.

Parameters:

a - the attribute set

Returns:

the fill proportion or 1, if not defined

See Also:

setFillProportion(javax.swing.text.MutableAttributeSet, int)

getFormat

public static java.text.Format getFormat(javax.swing.text.AttributeSet a)

Returns the Format object that converts an object to text.

Parameters:

a - the attribute set

Returns:

the formatter, or an object that invokes toString, if not defined

See Also:

setFormat(javax.swing.text.MutableAttributeSet, java.text.Format)

getHorizontalGridFill

public static Fill getHorizontalGridFill(javax.swing.text.AttributeSet a)

Returns the coloring specification of horizontal grid lines.

Parameters:

a - the attribute set

Returns:

the horizontal grid fill or Fill.BLACK, if not defined

See Also:

setHorizontalGridFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getHorizontalGridThickness

public static double getHorizontalGridThickness(javax.swing.text.AttributeSet a)

Returns the height of horizontal grid lines.

Parameters:

a - the attribute set

Returns:

the horizontal grid thickness or 0.0, if not defined

See Also:

setHorizontalGridThickness(javax.swing.text.MutableAttributeSet, double)

getVerticalGridFill

public static Fill getVerticalGridFill(javax.swing.text.AttributeSet a)

Returns the coloring specification of vertical grid lines.

Parameters:

a - the attribute set

Returns:

the vertical grid fill or Fill.BLACK, if not defined

See Also:

setVerticalGridFill(javax.swing.text.MutableAttributeSet, sos.reports.Fill)

getVerticalGridThickness

public static double getVerticalGridThickness(javax.swing.text.AttributeSet a)

Returns the width of vertical grid lines.

Parameters:

a - the attribute set

Returns:

the vertical grid thickness or 0.0, if not defined

See Also:

setVerticalGridThickness(javax.swing.text.MutableAttributeSet, double)

getHorizontalAlignment

public static int getHorizontalAlignment(javax.swing.text.AttributeSet a)

Returns the horizontal alignment of cell contents.

Parameters:

a - the attribute set

Returns:

the horizontal alignment of cell contents or StyleConstants.ALIGN_JUSTIFIED, if not defined

See Also:

setHorizontalAlignment(javax.swing.text.MutableAttributeSet, int)

getMinimumHeight

public static double getMinimumHeight(javax.swing.text.AttributeSet a)

Returns the minimum height.

Parameters:

a - the attribute set

Returns:

the minimum height or 0.0, if not defined

See Also:

setMinimumHeight(javax.swing.text.MutableAttributeSet, double)

getMinimumWidth

public static double getMinimumWidth(javax.swing.text.AttributeSet a)

Returns the minimum width.

Parameters:

a - the attribute set

Returns:

the minimum width or 0.0, if not defined

See Also:

setMinimumWidth(javax.swing.text.MutableAttributeSet, double)

getOrphanColumnCount

public static int getOrphanColumnCount(javax.swing.text.AttributeSet a)

Returns the minimum number of columns before a page break is allowed.

Parameters:

a - the attribute set

Returns:

the number of orphan columns or 0, if not defined

See Also:

setOrphanColumnCount(javax.swing.text.MutableAttributeSet, int)

getOrphanRowCount

public static int getOrphanRowCount(javax.swing.text.AttributeSet a)

Returns the minimum number of rows before a page break is allowed.

Parameters:

a - the attribute set

Returns:

the number of orphan rows or 2, if not defined

See Also:

setOrphanRowCount(javax.swing.text.MutableAttributeSet, int)

getRenderer

public static ElementRenderer getRenderer(javax.swing.text.AttributeSet a)

Returns the renderer to use to display an element.

Parameters:

a - the attribute set

Returns:

the element renderer or null, if not defined

getReportTemplate

public static ReportTemplate getReportTemplate(javax.swing.text.AttributeSet a)

Returns the report template to use for a nested report.

Parameters:

a - the attribute set

Returns:

the report template to use for a nested report or null, if not defined

getRowCushionAfter

public static double getRowCushionAfter(javax.swing.text.AttributeSet a)

Returns the amount of space after interior rows.

Parameters:

a - the attribute set

Returns:

the gap after rows or 0.0, if not defined

See Also:

setRowCushionAfter(javax.swing.text.MutableAttributeSet, double)

getRowCushionBefore

public static double getRowCushionBefore(javax.swing.text.AttributeSet a)

Returns the amount of space before interior rows.

Parameters:

a - the attribute set

Returns:

the gap after before or 0.0, if not defined

See Also:

setRowCushionBefore(javax.swing.text.MutableAttributeSet, double)

getTableFormat

public static TableFormat getTableFormat(javax.swing.text.AttributeSet a)

Returns the table format setting.

Parameters:

a - the attribute set

Returns:

the table format, or a default TableFormat, if not defined

See Also:

setTableFormat(javax.swing.text.MutableAttributeSet, sos.reports.TableFormat)

getRotation

public static double getRotation(javax.swing.text.AttributeSet a)

Returns the text rotation setting.

Parameters:

a - the attribute set

Returns:

the text rotation, or 0, if not defined

See Also:

setRotation(javax.swing.text.MutableAttributeSet, double)

getTheme

public static Theme getTheme(javax.swing.text.AttributeSet a)

Returns the theme to use for a nested report.

Parameters:

a - the attribute set

Returns:

the theme to use for a nested report or null, if not defined

See Also:

setTheme(javax.swing.text.MutableAttributeSet, sos.reports.Theme)

getVerticalAlignment

public static int getVerticalAlignment(javax.swing.text.AttributeSet a)

Returns the vertical alignment of cell contents.

Parameters:

a - the attribute set

Returns:

the vertical alignment of cell contents or StyleConstants.ALIGN_JUSTIFIED, if not defined

See Also:

setVerticalAlignment(javax.swing.text.MutableAttributeSet, int)

getWidowColumnCount

public static int getWidowColumnCount(javax.swing.text.AttributeSet a)

Returns the minimum number of columns needed after a page break.

Parameters:

a - the attribute set

Returns:

the number of widow columns or 0, if not defined

See Also:

setWidowColumnCount(javax.swing.text.MutableAttributeSet, int)

getWidowRowCount

public static int getWidowRowCount(javax.swing.text.AttributeSet a)

Returns the minimum number of rows needed after a page break.

Parameters:

a - the attribute set

Returns:

the number of widow rows or 2, if not defined

See Also:

setWidowRowCount(javax.swing.text.MutableAttributeSet, int)

isAllCaps

public static boolean isAllCaps(javax.swing.text.AttributeSet a)

Returns the all caps setting. A value of true means text should be displayed in all capital letters.

Parameters:

a - the attribute set

Returns:

the all caps setting, or false, if not defined

See Also:

setAllCaps(javax.swing.text.MutableAttributeSet, boolean)

isAttributeInherited

public static boolean isAttributeInherited(java.lang.Object attribute)

Returns true if the specified attribute is known to be inherited.

Parameters:

attribute - attribute key to check if inherited

Returns:

true if attribute is inherited

isAutoFit

public static boolean isAutoFit(javax.swing.text.AttributeSet a)

Returns the auto fit setting. A value of true means text should be sized to best fit its container.

Parameters:

a - the attribute set

Returns:

the auto fit setting, or false, if not defined

See Also:

setAutoFit(javax.swing.text.MutableAttributeSet, boolean)

isKeptTogetherHorizontally

public static boolean isKeptTogetherHorizontally(javax.swing.text.AttributeSet a)

Returns true if the element should not be broken horizontally.

Parameters:

a - the attribute set

Returns:

the setting for horizontal breaking or false, if not defined

See Also:

setKeptTogetherHorizontally(javax.swing.text.MutableAttributeSet, boolean)

isKeptTogetherVertically

public static boolean isKeptTogetherVertically(javax.swing.text.AttributeSet a)

Returns true if the element should not be broken vertically.

Parameters:

a - the attribute set

Returns:

the setting for vertical breaking or false, if not defined

See Also:

setKeptTogetherVertically(javax.swing.text.MutableAttributeSet, boolean)

isKeptWithNext

public static boolean isKeptWithNext(javax.swing.text.AttributeSet a)

Returns true if the tier should be on the same page as the next tier.

Parameters:

a - the attribute set

Returns:

the setting for keeping a tier with the following tier or false, if not defined

See Also:

setKeptWithNext(javax.swing.text.MutableAttributeSet, boolean)

isKeptWithPrevious

public static boolean isKeptWithPrevious(javax.swing.text.AttributeSet a)

Returns true if the tier should be on the same page as the previous tier.

Parameters:

a - the attribute set

Returns:

the setting for keeping a tier with the preceding tier or false, if not defined

See Also:

setKeptWithPrevious(javax.swing.text.MutableAttributeSet, boolean)

isPageBreak

public static boolean isPageBreak(javax.swing.text.AttributeSet a)

Returns true if a page break is desired.

Parameters:

a - the attribute set

Returns:

the setting for a forced page break or false, if not defined

See Also:

setPageBreak(javax.swing.text.MutableAttributeSet, boolean)

isWrapped

public static boolean isWrapped(javax.swing.text.AttributeSet a)

Returns true if text is allowed to wrap.

Parameters:

a - the attribute set

Returns:

the setting for text wrapping or true, if not defined

See Also:

setWrapped(javax.swing.text.MutableAttributeSet, boolean)

setAllCaps

public static void setAllCaps(javax.swing.text.MutableAttributeSet a,
                              boolean b)

Sets whether or not text should be in all capital letters.

Parameters:

a - the attribute set

b - true for all caps

See Also:

isAllCaps(javax.swing.text.AttributeSet)

setAutoFit

public static void setAutoFit(javax.swing.text.MutableAttributeSet a,
                              boolean b)

Sets whether or not text should be sized to fit its container.

Parameters:

a - the attribute set

b - true for auto-sizing

See Also:

isAutoFit(javax.swing.text.AttributeSet)

setBackgroundFill

public static void setBackgroundFill(javax.swing.text.MutableAttributeSet a,
                                     Fill fill)

Sets the background coloring specification.

Parameters:

a - the attribute set

fill - the background fill

See Also:

getBackgroundFill(javax.swing.text.AttributeSet)

setBorderFill

public static void setBorderFill(javax.swing.text.MutableAttributeSet a,
                                 Fill fill)

Sets the coloring specification of the left, right, top, and bottom border.

Parameters:

a - the attribute set

fill - the border fill

See Also:

getBorderFill(javax.swing.text.AttributeSet)

setBorderThickness

public static void setBorderThickness(javax.swing.text.MutableAttributeSet a,
                                      double thickness)

Sets the thickness of the left, right, top, and bottom border.

Parameters:

a - the attribute set

thickness - thickness of the left, right, top, and bottom border

See Also:

getBorderThickness(javax.swing.text.AttributeSet)

setBottomBorderFill

public static void setBottomBorderFill(javax.swing.text.MutableAttributeSet a,
                                       Fill fill)

Sets the coloring specification of the bottom border.

Parameters:

a - the attribute set

fill - the border fill

See Also:

getBottomBorderFill(javax.swing.text.AttributeSet)

setBottomBorderThickness

public static void setBottomBorderThickness(javax.swing.text.MutableAttributeSet a,
                                            double thickness)

Sets the height of the bottom border.

Parameters:

a - the attribute set

thickness - height of the bottom border

See Also:

getBottomBorderThickness(javax.swing.text.AttributeSet)

setLeftBorderFill

public static void setLeftBorderFill(javax.swing.text.MutableAttributeSet a,
                                     Fill fill)

Sets the coloring specification of the left border.

Parameters:

a - the attribute set

fill - the border fill

See Also:

getLeftBorderFill(javax.swing.text.AttributeSet)

setLeftBorderThickness

public static void setLeftBorderThickness(javax.swing.text.MutableAttributeSet a,
                                          double thickness)

Sets the width of the left border.

Parameters:

a - the attribute set

thickness - width of the left border

See Also:

getLeftBorderThickness(javax.swing.text.AttributeSet)

setRightBorderFill

public static void setRightBorderFill(javax.swing.text.MutableAttributeSet a,
                                      Fill fill)

Sets the coloring specification of the right border.

Parameters:

a - the attribute set

fill - the border fill

See Also:

getRightBorderFill(javax.swing.text.AttributeSet)

setRightBorderThickness

public static void setRightBorderThickness(javax.swing.text.MutableAttributeSet a,
                                           double thickness)

Sets the width of the right border.

Parameters:

a - the attribute set

thickness - width of the right border

See Also:

getRightBorderThickness(javax.swing.text.AttributeSet)

setTopBorderFill

public static void setTopBorderFill(javax.swing.text.MutableAttributeSet a,
                                    Fill fill)

Sets the coloring specification of the top border.

Parameters:

a - the attribute set

fill - the border fill

See Also:

getTopBorderFill(javax.swing.text.AttributeSet)

setTopBorderThickness

public static void setTopBorderThickness(javax.swing.text.MutableAttributeSet a,
                                         double thickness)

Sets the height of the top border.

Parameters:

a - the attribute set

thickness - height of the top border

See Also:

getTopBorderThickness(javax.swing.text.AttributeSet)

setToolTip

public static void setToolTip(javax.swing.text.MutableAttributeSet a,
                              java.lang.String toolTip)

Sets the tool tip.

Parameters:

a - the attribute set

See Also:

getToolTip(javax.swing.text.AttributeSet)

setFillProportion

public static void setFillProportion(javax.swing.text.MutableAttributeSet a,
                                     int fillProportion)

Sets the relative amount of excess space that a tier wishes to assume.

Parameters:

a - the attribute set

fillProportion - the non-negative fill proportion

See Also:

getFillProportion(javax.swing.text.AttributeSet)

setFormat

public static void setFormat(javax.swing.text.MutableAttributeSet a,
                             java.text.Format format)

Sets the object that converts objects to text.

Parameters:

a - the attribute set

format - the desired mapping from object to text

See Also:

getFormat(javax.swing.text.AttributeSet)

setHorizontalGridFill

public static void setHorizontalGridFill(javax.swing.text.MutableAttributeSet a,
                                         Fill fill)

Sets the coloring specification of horizontal grid lines.

Parameters:

a - the attribute set

fill - the desired background coloring of horizontal grid lines

See Also:

getHorizontalGridFill(javax.swing.text.AttributeSet)

setHorizontalGridThickness

public static void setHorizontalGridThickness(javax.swing.text.MutableAttributeSet a,
                                              double thickness)

Sets the height of horizontal grid lines.

Parameters:

a - the attribute set

thickness - the desired height of horizontal grid lines

See Also:

getHorizontalGridThickness(javax.swing.text.AttributeSet)

setVerticalGridFill

public static void setVerticalGridFill(javax.swing.text.MutableAttributeSet a,
                                       Fill fill)

Sets the coloring specification of vertical grid lines.

Parameters:

a - the attribute set

fill - the desired background coloring of vertical grid lines

See Also:

getVerticalGridFill(javax.swing.text.AttributeSet)

setVerticalGridThickness

public static void setVerticalGridThickness(javax.swing.text.MutableAttributeSet a,
                                            double thickness)

Sets the height of vertical grid lines.

Parameters:

a - the attribute set

thickness - the desired height of vertical grid lines

See Also:

getVerticalGridThickness(javax.swing.text.AttributeSet)

setColumnCushionAfter

public static void setColumnCushionAfter(javax.swing.text.MutableAttributeSet a,
                                         double cushion)

Sets the amount of space after interior columns.

Parameters:

a - the attribute set

cushion - the desired padding after columns

See Also:

getColumnCushionAfter(javax.swing.text.AttributeSet)

setColumnCushionBefore

public static void setColumnCushionBefore(javax.swing.text.MutableAttributeSet a,
                                          double cushion)

Sets the amount of space before interior columns.

Parameters:

a - the attribute set

cushion - the desired padding before columns

See Also:

getColumnCushionBefore(javax.swing.text.AttributeSet)

setHorizontalAlignment

public static void setHorizontalAlignment(javax.swing.text.MutableAttributeSet a,
                                          int alignment)

Sets the horizontal alignment of cell contents.

Parameters:

a - the attribute set

alignment - the desired alignment (one of ALIGN_JUSTIFIED, ALIGN_TOP, ALIGN_BOTTOM, and ALIGN_CENTER)

See Also:

getHorizontalAlignment(javax.swing.text.AttributeSet)

setKeptTogetherHorizontally

public static void setKeptTogetherHorizontally(javax.swing.text.MutableAttributeSet a,
                                               boolean b)

Sets an element's inability to be broken horizontally.

Parameters:

a - the attribute set

b - true if the element cannot be broken horizontally

See Also:

isKeptTogetherHorizontally(javax.swing.text.AttributeSet)

setKeptTogetherVertically

public static void setKeptTogetherVertically(javax.swing.text.MutableAttributeSet a,
                                             boolean b)

Sets an element's inability to be broken vertically.

Parameters:

a - the attribute set

b - true if the element cannot be broken vertically

See Also:

isKeptTogetherVertically(javax.swing.text.AttributeSet)

setKeptWithNext

public static void setKeptWithNext(javax.swing.text.MutableAttributeSet a,
                                   boolean b)

Sets a tier's desire to be on the same page with the next tier.

Parameters:

a - the attribute set

b - true if the tier should be on the same page as the next tier

See Also:

isKeptWithNext(javax.swing.text.AttributeSet)

setKeptWithPrevious

public static void setKeptWithPrevious(javax.swing.text.MutableAttributeSet a,
                                       boolean b)

Sets a tier's desire to be on the same page with the previous tier.

Parameters:

a - the attribute set

b - true if the tier should be on the same page as the previous tier

See Also:

isKeptWithPrevious(javax.swing.text.AttributeSet)

setPageBreak

public static void setPageBreak(javax.swing.text.MutableAttributeSet a,
                                boolean b)

Sets a tier's desire to be on the next page.

Parameters:

a - the attribute set

b - true if a page break is desired

See Also:

isPageBreak(javax.swing.text.AttributeSet)

setMinimumHeight

public static void setMinimumHeight(javax.swing.text.MutableAttributeSet a,
                                    double height)

Sets the minimum height.

Parameters:

a - the attribute set

height - the desired minimum height

See Also:

getMinimumHeight(javax.swing.text.AttributeSet)

setMinimumWidth

public static void setMinimumWidth(javax.swing.text.MutableAttributeSet a,
                                   double width)

Sets the minimum width.

Parameters:

a - the attribute set

See Also:

getMinimumWidth(javax.swing.text.AttributeSet)

setOrphanColumnCount

public static void setOrphanColumnCount(javax.swing.text.MutableAttributeSet a,
                                        int orphanCount)

Sets the minimum number of columns before a page break is allowed.

Parameters:

a - the attribute set

orphanCount - the desired orphan column count

See Also:

getOrphanColumnCount(javax.swing.text.AttributeSet)

setOrphanRowCount

public static void setOrphanRowCount(javax.swing.text.MutableAttributeSet a,
                                     int orphanCount)

Sets the minimum number of rows before a page break is allowed.

Parameters:

a - the attribute set

orphanCount - the desired orphan row count

See Also:

getOrphanRowCount(javax.swing.text.AttributeSet)

setRenderer

public static void setRenderer(javax.swing.text.MutableAttributeSet a,
                               ElementRenderer renderer)

Sets the renderer to use to display an element.

Parameters:

a - the attribute set

renderer - the desired element renderer

See Also:

getRenderer(javax.swing.text.AttributeSet)

setReportTemplate

public static void setReportTemplate(javax.swing.text.MutableAttributeSet a,
                                     ReportTemplate reportTemplate)

Sets the report template to use for a nested report.

Parameters:

a - the attribute set

reportTemplate - the desired nested report template

See Also:

getReportTemplate(javax.swing.text.AttributeSet)

setRowCushionAfter

public static void setRowCushionAfter(javax.swing.text.MutableAttributeSet a,
                                      double cushion)

Sets the amount of space after interior rows.

Parameters:

a - the attribute set

cushion - the desired padding after rows

See Also:

getRowCushionAfter(javax.swing.text.AttributeSet)

setRowCushionBefore

public static void setRowCushionBefore(javax.swing.text.MutableAttributeSet a,
                                       double cushion)

Sets the amount of space before interior rows.

Parameters:

a - the attribute set

cushion - the desired padding before rows

See Also:

getRowCushionBefore(javax.swing.text.AttributeSet)

setTableFormat

public static void setTableFormat(javax.swing.text.MutableAttributeSet a,
                                  TableFormat tableFormat)

Sets the table format.

Parameters:

a - the attribute set

tableFormat - the desired table format

setRotation

public static void setRotation(javax.swing.text.MutableAttributeSet a,
                               double rotation)

Sets the rotation (in radians).

Parameters:

a - the attribute set

rotation - the desired rotation (in radians)

setTheme

public static void setTheme(javax.swing.text.MutableAttributeSet a,
                            Theme theme)

Sets the theme to use for a nested report.

Parameters:

a - the attribute set

theme - the nested report's theme

See Also:

getTheme(javax.swing.text.AttributeSet)

setVerticalAlignment

public static void setVerticalAlignment(javax.swing.text.MutableAttributeSet a,
                                        int alignment)

Sets the vertical alignment of cell contents.

Parameters:

a - the attribute set

alignment - the desired alignment (one of ALIGN_JUSTIFIED, ALIGN_TOP, ALIGN_BOTTOM, and ALIGN_CENTER)

See Also:

getVerticalAlignment(javax.swing.text.AttributeSet)

setWidowColumnCount

public static void setWidowColumnCount(javax.swing.text.MutableAttributeSet a,
                                       int widowCount)

Sets the minimum number of columns needed after a page break.

Parameters:

a - the attribute set

widowCount - the desired window column count

See Also:

getWidowColumnCount(javax.swing.text.AttributeSet)

setWidowRowCount

public static void setWidowRowCount(javax.swing.text.MutableAttributeSet a,
                                    int widowCount)

Sets the minimum number of rows needed after a page break.

Parameters:

a - the attribute set

widowCount - the desired window row count

See Also:

getWidowRowCount(javax.swing.text.AttributeSet)

setWrapped

public static void setWrapped(javax.swing.text.MutableAttributeSet a,
                              boolean b)

Sets whether or not text is allowed to wrap.

Parameters:

a - the attribute set

b - true if multi-line text is allowed

See Also:

isWrapped(javax.swing.text.AttributeSet)

getPadding

public static double getPadding(javax.swing.text.AttributeSet a)

Returns the left, right, top, and bottom margin.

Parameters:

a - the attribute set

Returns:

the left, right, top, and bottom margin or 0.0, if not defined

See Also:

setPadding(javax.swing.text.MutableAttributeSet, double)

getLeftPadding

public static double getLeftPadding(javax.swing.text.AttributeSet a)

Returns the left margin.

Parameters:

a - the attribute set

Returns:

the left margin or 0.0, if not defined

See Also:

setLeftPadding(javax.swing.text.MutableAttributeSet, double)

getRightPadding

public static double getRightPadding(javax.swing.text.AttributeSet a)

Returns the right margin.

Parameters:

a - the attribute set

Returns:

the right margin or 0.0, if not defined

See Also:

setRightPadding(javax.swing.text.MutableAttributeSet, double)

getTopPadding

public static double getTopPadding(javax.swing.text.AttributeSet a)

Returns the top margin.

Parameters:

a - the attribute set

Returns:

the top margin or 0.0, if not defined

See Also:

setTopPadding(javax.swing.text.MutableAttributeSet, double)

getBottomPadding

public static double getBottomPadding(javax.swing.text.AttributeSet a)

Returns the bottom margin.

Parameters:

a - the attribute set

Returns:

the bottom margin or 0.0, if not defined

See Also:

setBottomPadding(javax.swing.text.MutableAttributeSet, double)

setPadding

public static void setPadding(javax.swing.text.MutableAttributeSet a,
                              double padding)

Sets the left, right, top, and bottom margins.

Parameters:

a - the attribute set

padding - the desired left, right, top, and bottom margin

See Also:

getPadding(javax.swing.text.AttributeSet)

setLeftPadding

public static void setLeftPadding(javax.swing.text.MutableAttributeSet a,
                                  double padding)

Sets the left padding.

Parameters:

a - the attribute set

padding - the desired left margin

See Also:

getLeftPadding(javax.swing.text.AttributeSet)

setRightPadding

public static void setRightPadding(javax.swing.text.MutableAttributeSet a,
                                   double padding)

Sets the right padding.

Parameters:

a - the attribute set

padding - the desired right margin

See Also:

getRightPadding(javax.swing.text.AttributeSet)

setTopPadding

public static void setTopPadding(javax.swing.text.MutableAttributeSet a,
                                 double padding)

Sets the top padding.

Parameters:

a - the attribute set

padding - the desired top margin

See Also:

getTopPadding(javax.swing.text.AttributeSet)

setBottomPadding

public static void setBottomPadding(javax.swing.text.MutableAttributeSet a,
                                    double padding)

Sets the bottom padding.

Parameters:

a - the attribute set

padding - the desired bottom margin

See Also:

getBottomPadding(javax.swing.text.AttributeSet)

toString

public java.lang.String toString()

Returns the string representation.

Overrides:

toString in class java.lang.Object

Returns:

the string