Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Excerpt

Defines a sub-band within an other band i.e. group header, report footer, etc.

This can be used to group objects and to trigger the visibility or change the style of the whole group using a single operation. Bands can have their own layout manager attached, which is also the only way to stack dynamic elements below each other in a safe way.

Attributes

Description

alignment

Sets the horizontal justification of the text based on a defined width.

Type: String
Default Value: left
Values: left | center | right

color

Sets the font color by the using RGB-triplet (#ffffff for white; #ff0000 for red, etc) or from list of the predefined colors below.

Type: String
Default Value: black
Predefined Values: black | blue| cyan | darkGray | gray | green | lightGray | magenta | orange | pink | red | white | yellow

dynamic

A dynamic element increases the height of the element to fit the content of that element. Computing that dynamic height is expensive, so use it with care.

excel-wrap-text

When outputting to Excel, sets the text to word wrap.

Type: Boolean
Default Value: false

font-embedded

Specifies the font to embed into the PDF file.

Type: String

font-encoding

Specifies the encoding to be used for the PDF.

Type: String

fontname

Sets the font name.

Type: String

fontsize

Sets the font size.

Type: Integer

fontstyle

Sets font style.

Type: String

fsbold

Sets font to italics.

Type: Boolean
Default Value: false

fsitalic

Sets font to italics.

Type: Boolean
Default Value: false

fsstrikethr

Sets font to strikethrough.

Type: Boolean
Default Value: false

fsunderline

Sets font to underline.

Type: Boolean
Default Value: false

height

Determines the minimum height. Value is a whole number where each increment is equivalent to 1/72 of an inch or percentage.

Type: Integer
Default: If no height is specified, then height will be determine by all the objects contained.

href

Sets a hyperlink for the section.

Type: String

line-height

The height of a single text line in text elements. If the line-height is set and is greater than the font size, extra padding will be added between the lines making text more readable.

Type: Integer

name

Used to reference the element later. Functions pick up elements by their name.

Type: String

reserve-literal

Determines the text printed when the text does not fit completely into an element.

Type: String
Default value: "..."

trim-text-content

Defines, whether leading and trailing whitespaces of the generated lines get removed. Important for a clean layout.

Type: Boolean
Default Value: true

vertical-alignment

Sets the vertical position of the text.

Default Value: top
Values: top | middle | bottom

visible

Sets whether the object will be printed.

Type: Boolean
Default Value: true

width

Set the horizontal width of the object.

x

Defines the horizontal starting position an object defined by a value or percentage.

y

Defines the vertical starting position of an object defined by a value or percentage.