package core
- Alphabetic
- By Inheritance
- core
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Package Members
- package components
- package crosstabs
Type Members
- sealed abstract class AbstractStyle extends AnyRef
- abstract class Anchor extends AnyRef
- sealed case class Band(splitType: SplitTypeEnum, content: Element, height: BandHeight = BandHeight.Auto, printWhenExpression: Option[Expression[Boolean]] = None) extends Product with Serializable
- sealed abstract class BandHeight extends AnyRef
- sealed case class BoxPadding(top: Option[Int] = None, left: Option[Int] = None, bottom: Option[Int] = None, right: Option[Int] = None) extends Product with Serializable
- sealed case class BoxPen(top: Pen = Pen.empty, left: Pen = Pen.empty, bottom: Pen = Pen.empty, right: Pen = Pen.empty) extends Product with Serializable
- sealed case class Break(key: String, y: YPos, conditions: Conditions, breakType: BreakTypeEnum) extends Element with Product with Serializable
- sealed case class Columns(count: Int = 1, direction: RunDirectionEnum = RunDirectionEnum.LTR, footer: Option[FloatingBand] = None, header: Option[Band] = None, spacing: Length = 0.px, width: RestrictedLength = 100.percent, printOrder: PrintOrderEnum = PrintOrderEnum.VERTICAL) extends Product with Serializable
- sealed case class ComponentElement(component: Component, height: Height, width: Width = Width.Remaining, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, key: String = "") extends Element with Product with Serializable
- sealed case class Conditions(printInFirstWholeBand: Boolean = false, printWhenExpression: Option[Expression[Boolean]] = None, printRepeatedValues: Boolean = true, printWhenDetailOverflows: Boolean = false, printWhenGroupChanges: Option[Group] = None, removeLineWhenBlank: Boolean = false) extends Product with Serializable
- sealed abstract class Data extends AnyRef
- sealed case class DataDef(dataset: Dataset, source: Expression[JRDataSource], arguments: Map[String, Expression[Any]] = Map.empty) extends Data with Product with Serializable
- sealed case class Dataset(parameters: Seq[Parameter] = Vector.empty, variables: Seq[Variable] = Vector.empty, fields: Map[String, String] = Map.empty, sortFields: Seq[SortField] = Vector.empty, query: JRDesignQuery = null, scriptlets: IndexedSeq[JRScriptlet] = Vector.empty, scriptletClassName: Option[String] = None, groups: Map[String, Group] = Map.empty, resourceBundle: Option[String] = None, filterExpression: Option[Expression[Boolean]] = None, whenResourceMissingType: WhenResourceMissingTypeEnum = WhenResourceMissingTypeEnum.NULL, customProperties: Map[String, String] = Map.empty) extends Product with Serializable
- sealed case class DatasetRun(datasetName: String, arguments: Map[String, Expression[Any]] = Map.empty, argumentsMapExpression: Option[Expression[Map[String, AnyRef]]] = None, dataSourceExpression: Option[Expression[JRDataSource]] = None, connectionExpression: Option[Expression[Connection]] = None) extends Data with Product with Serializable
use DataDef instead
- abstract class Element extends AnyRef
- sealed case class ElementGroup(content: Seq[Element]) extends Element with Product with Serializable
The only reason to group your report elements is to customize their stretch behavior.
- sealed case class ElementSeq(elements: Seq[Element]) extends Element with Product with Serializable
Element sequences are totally transparent, e.g.
Element sequences are totally transparent, e.g. an Element e behaves exactly the same if it is nested in an ElementSeq or not. Various utilities in this library freely pack and unpack elements from these sequences.
- sealed case class Ellipse(width: Width, height: Height, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, key: String = "") extends Element with Product with Serializable
- sealed abstract class EvaluationTime extends AnyRef
- abstract class Expression[+A] extends AnyRef
- See also
See companion object for various functions that return Expression objects.
- sealed case class FloatingBand(band: Band, floating: Boolean = false) extends Product with Serializable
- sealed case class Font(fontName: Option[String] = None, fontSize: Option[Float] = None, bold: Option[Boolean] = None, italic: Option[Boolean] = None, strikeThrough: Option[Boolean] = None, underline: Option[Boolean] = None, pdfEncoding: Option[String] = None, pdfFontName: Option[String] = None, pdfEmbedded: Option[Boolean] = None) extends Product with Serializable
- sealed case class Frame(height: Height, content: Element, x: RestrictedLength = 0.px, y: YPos = YPos.float(0.px), width: Width = Width.Remaining, style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, key: String = "") extends Element with Product with Serializable
- sealed case class Group(expression: Expression[Any], header: Seq[Band] = Vector.empty, footer: Seq[Band] = Vector.empty, footerPosition: FooterPositionEnum = FooterPositionEnum.NORMAL, startNewColumn: Boolean = false, resetPageNumber: Boolean = false, reprintHeaderOnEachPage: Boolean = false, minHeightToStartNewPage: Int = 0, keepTogether: Boolean = false) extends Product with Serializable
- sealed case class Height(value: VerticalLength, stretchType: StretchTypeEnum) extends Product with Serializable
Height of an element
- abstract class Hyperlink extends AnyRef
When the user clicks a hyperlink, he or she is redirected to a local destination within the current document or to an external resource.
- sealed abstract class HyperlinkTarget extends AnyRef
- sealed case class Image(expression: Expression[Any], width: Width, height: Height, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, key: String = "", usingCache: Option[Boolean] = None, lazily: Boolean = false, onError: OnErrorTypeEnum = net.sf.jasperreports.engine.`type`.OnErrorTypeEnum.ERROR, evaluationTime: EvaluationTime = EvaluationTime.Now, link: Link = Link.empty, anchor: Anchor = Anchor.None) extends Element with Product with Serializable
- sealed abstract class Increment extends AnyRef
- sealed case class Line(width: Width, height: Height, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, key: String = "", direction: LineDirectionEnum = net.sf.jasperreports.engine.`type`.LineDirectionEnum.TOP_DOWN) extends Element with Product with Serializable
- sealed case class LineBox(pen: BoxPen = BoxPen.empty, padding: BoxPadding = BoxPadding.empty) extends Product with Serializable
- sealed abstract class LineSpacing extends AnyRef
- sealed case class Link(hyperlink: Hyperlink, target: HyperlinkTarget, tooltip: Option[Expression[String]]) extends Product with Serializable
- sealed case class Margins(top: RestrictedLength = 0.px, right: RestrictedLength = 0.px, bottom: RestrictedLength = 0.px, left: RestrictedLength = 0.px) extends Product with Serializable
top and bottom margins can be relative to the page height, left and right relative to the page with
- sealed case class Page(format: PageFormat = PageFormat.A4, margins: Margins = Margins.default, footer: Option[Band] = None, header: Option[Band] = None, background: Option[Band] = None, columns: Columns = Columns.singleColumn) extends Product with Serializable
- sealed case class PageFormat(width: Length, height: Length, orientation: OrientationEnum) extends Product with Serializable
Orientation is used mostly to inform printers of page layouts.
- sealed case class Paragraph(lineSpacing: Option[LineSpacing] = None, firstLineIndent: Option[Int] = None, leftIndent: Option[Int] = None, rightIndent: Option[Int] = None, spacingBefore: Option[Int] = None, spacingAfter: Option[Int] = None, tabStopWidth: Option[Int] = None, tabStops: Seq[TabStop] = Seq.empty) extends Product with Serializable
- sealed case class Parameter(name: String, defaultValueExpression: Option[Expression[Any]] = None, isForPrompting: Boolean = false, nestedTypeName: String = null, valueClassName: String = "java.lang.String", description: String = "") extends Product with Serializable
- sealed case class Pen(lineColor: Option[Color] = None, lineStyle: Option[LineStyleEnum] = None, lineWidth: Option[Float] = None) extends Product with Serializable
- sealed case class Rectangle(width: Width, height: Height, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, key: String = "") extends Element with Product with Serializable
- sealed case class Report(name: String, details: Seq[Band] = Vector.empty, defaultStyle: Style = Style.empty, styles: Map[String, Style] = Map.empty, templates: IndexedSeq[JRReportTemplate] = Vector.empty, subDatasets: Map[String, Dataset] = Map.empty, mainDataset: Dataset = Dataset.empty, imports: Set[String] = Set.empty, ignorePagination: Boolean = false, language: String = net.sf.jasperreports.engine.JRReport.LANGUAGE_JAVA, lastPageFooter: Option[Band] = None, noData: Option[Band] = None, page: Page = Page.default, summary: Option[SummaryBand] = None, title: Option[TitleBand] = None) extends Product with Serializable
- sealed abstract class Reset extends AnyRef
- sealed case class ReturnValue(subreportVariable: String, toVariable: String, calculation: CalculationEnum = CalculationEnum.NOTHING, incrementerFactoryClassName: Option[String]) extends Product with Serializable
- sealed case class SortField(name: String, order: SortOrderEnum, fieldType: SortFieldTypeEnum) extends Product with Serializable
- sealed case class StaticText(text: String, height: Height = Height.fixed(1.0.em), width: Width = Width.Remaining, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), key: String = "", style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default) extends Element with Product with Serializable
- sealed case class Style(parentStyle: Option[StyleReference] = None, conditionalStyles: Seq[(Expression[Boolean], Style)] = Vector.empty, backcolor: Option[Color] = None, forecolor: Option[Color] = None, font: Font = Font.empty, horizontalImageAlignment: Option[HorizontalImageAlignEnum] = None, horizontalTextAlignment: Option[HorizontalTextAlignEnum] = None, paragraph: Paragraph = Paragraph.empty, markup: Option[String] = None, mode: Option[ModeEnum] = None, pattern: Option[String] = None, radius: Option[Int] = None, rotation: Option[RotationEnum] = None, scaleImage: Option[ScaleImageEnum] = None, verticalImageAlignment: Option[VerticalImageAlignEnum] = None, verticalTextAlignment: Option[VerticalTextAlignEnum] = None, line: Pen = Pen.empty, box: LineBox = LineBox.empty, fill: Option[FillEnum] = None, blankWhenNull: Option[Boolean] = None) extends AbstractStyle with Product with Serializable
- sealed case class StyleReference(reference: String) extends AbstractStyle with Product with Serializable
- sealed case class Subreport(subreportExpression: Expression[Any], height: Height, width: Width = Width.Remaining, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, key: String = "", arguments: Map[String, Expression[Any]] = Map.empty, argumentsMapExpression: Option[Expression[Map[String, AnyRef]]] = None, usingCache: Option[Boolean] = None, dataSourceExpression: Option[Expression[JRDataSource]] = None, connectionExpression: Option[Expression[Connection]] = None, returnValues: Seq[ReturnValue] = Vector.empty) extends Element with Product with Serializable
- sealed case class SummaryBand(band: Band, newPage: Boolean = false, withPageHeaderAndFooter: Boolean = false) extends Product with Serializable
- sealed case class TabStop(position: Int, align: TabStopAlignEnum) extends Product with Serializable
- sealed case class TextField(expression: Expression[Any], height: Height = Height.fixed(1.0.em), width: Width = Width.Remaining, x: RestrictedLength = 0.px, y: YPos = YPos.float(0 px), key: String = "", style: AbstractStyle = Style.inherit, conditions: Conditions = Conditions.default, link: Link = Link.empty, anchor: Anchor = Anchor.None, stretchWithOverflow: Boolean = false, evaluationTime: EvaluationTime = EvaluationTime.Now, patternExpression: Option[Expression[Any]] = None) extends Element with Product with Serializable
- sealed case class TitleBand(band: Band, newPage: Boolean = false) extends Product with Serializable
- sealed case class Variable(name: String, calculation: CalculationEnum, expression: Expression[Any], valueClassName: String = "java.lang.String", increment: Increment = Increment.None, reset: Reset = Reset.Report, incrementerFactoryClassName: Option[String] = None) extends Product with Serializable
- sealed abstract class Width extends AnyRef
- sealed case class YPos(value: VerticalLength, positionType: PositionTypeEnum) extends Product with Serializable
Vertical position of an element
Value Members
- implicit def absoluteLength(l: Length): RestrictedLength
- implicit def absoluteVertical(value: Length): AbsoluteVerticalLength
- def compile(r: Report): JasperReport
Creates a JasperReport object (a report template) that can be stored for later use.
Creates a JasperReport object (a report template) that can be stored for later use. May throw an exception if the report cannot be stored; use prepare or print if unsure.
- implicit def fontRelatedVertical(value: FontSizedLength): FontRelatedVerticalLength
- implicit def fractionValue(value: Int): FractionValue
- implicit def fractionValue(value: Double): FractionValue
- implicit def lengthValue(value: Int): LengthValue
- implicit def lengthValue(value: Double): LengthValue
- implicit def liftElements(l: Seq[Element]): Element
- implicit def partialLength(p: FractionValue): RestrictedLength
- def prepare(r: Report): (JasperReport, Map[String, AnyRef])
Creates a JasperReport object (a report template) and a map of fixed arguments to generated parameters, which can be combined with additional arguments and passed to print later.
Creates a JasperReport object (a report template) and a map of fixed arguments to generated parameters, which can be combined with additional arguments and passed to print later. This way the overhead can be reduced if many similar reports have to be created for different data.
- def print(r: Report, args: Map[String, AnyRef] = Map.empty, ds: JRDataSource = null): JasperPrint
Creates a JasperPrint object of the report, optionally specifying a map of named arguments and a datasource
- def printJasperReport(jreport: JasperReport, args: Map[String, AnyRef] = Map.empty, ds: JRDataSource = null): JasperPrint
Creates a JasperPrint object of the JasperPrint, optionally specifying a map of named arguments and a datasource
- implicit def specificWidth(value: Length): Specific
- implicit def specificWidth(value: FractionValue): Specific
- implicit def specificWidth(value: RestrictedLength): Specific
- object Anchor
- object BandHeight
- object BoxPadding extends Serializable
- object BoxPen extends Serializable
- object Break extends Serializable
- object Columns extends Serializable
- object Compiler
- object Conditions extends Serializable
- object Dataset extends Serializable
- object Dimensions
- object Element
- object ElementGroup extends Serializable
- object EvaluationTime
- object Expression
This object provides various ways to create Expression objects.
- object Font extends Serializable
- object Height extends Serializable
- object Hyperlink
- object HyperlinkTarget
- object Increment
- object LineBox extends Serializable
- object LineSpacing
- object Link extends Serializable
- object Margins extends Serializable
- object Page extends Serializable
- object PageFormat extends Serializable
- object Paragraph extends Serializable
- object Pen extends Serializable
- object Reset
- object Style extends Serializable
- object Subreport extends Serializable
- object TabStop extends Serializable
- object Width
- object YPos extends Serializable