ScalaJasper
API
Generated with
ScalaJasper/de.activegroup.scalajasper.core

de.activegroup.scalajasper.core

package de.activegroup.scalajasper.core

Members list

Packages

package de.activegroup.scalajasper.core.components
package de.activegroup.scalajasper.core.crosstabs

Type members

Classlikes

sealed abstract class AbstractStyle

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Style
abstract class Anchor

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Bookmark
object None
class Plain
object Anchor

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Anchor.type
sealed case class Band(splitType: SplitTypeEnum, content: Element, height: BandHeight, printWhenExpression: Option[Expression[Boolean]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract class BandHeight

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Auto
class AutoPlus
class Fixed
object BandHeight

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
BandHeight.type
sealed case class BoxPadding(top: Option[Int], left: Option[Int], bottom: Option[Int], right: Option[Int])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BoxPadding

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
BoxPadding.type
sealed case class BoxPen(top: Pen, left: Pen, bottom: Pen, right: Pen)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BoxPen

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
BoxPen.type
sealed case class Break(key: String, y: YPos, conditions: Conditions, breakType: BreakTypeEnum) extends Element

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
object Break

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Break.type
sealed case class Columns(count: Int, direction: RunDirectionEnum, footer: Option[FloatingBand], header: Option[Band], spacing: Length, width: RestrictedLength, printOrder: PrintOrderEnum)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Columns

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Columns.type
object Compiler

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Compiler.type
sealed case class ComponentElement(component: Component, height: Height, width: Width, x: RestrictedLength, y: YPos, style: AbstractStyle, conditions: Conditions, key: String) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed case class Conditions(printInFirstWholeBand: Boolean, printWhenExpression: Option[Expression[Boolean]], printRepeatedValues: Boolean, printWhenDetailOverflows: Boolean, printWhenGroupChanges: Option[Group], removeLineWhenBlank: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Conditions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Conditions.type
sealed abstract class Data

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DataDef
class DatasetRun
sealed case class DataDef(dataset: Dataset, source: Expression[JRDataSource], arguments: Map[String, Expression[Any]]) extends Data

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Data
class Object
trait Matchable
class Any
Show all
sealed case class Dataset(parameters: Seq[Parameter], variables: Seq[Variable], fields: Map[String, String], sortFields: Seq[SortField], query: JRDesignQuery, scriptlets: IndexedSeq[JRScriptlet], scriptletClassName: Option[String], groups: Map[String, Group], resourceBundle: Option[String], filterExpression: Option[Expression[Boolean]], whenResourceMissingType: WhenResourceMissingTypeEnum, customProperties: Map[String, String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Dataset

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Dataset.type
sealed case class DatasetRun(datasetName: String, arguments: Map[String, Expression[Any]], argumentsMapExpression: Option[Expression[Map[String, AnyRef]]], dataSourceExpression: Option[Expression[JRDataSource]], connectionExpression: Option[Expression[Connection]]) extends Data

use DataDef instead

use DataDef instead

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Data
class Object
trait Matchable
class Any
Show all
object Dimensions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Dimensions.type
abstract class Element

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Crosstab
class Break
class ElementGroup
class ElementSeq
class Ellipse
class Frame
class Image
class Line
class Rectangle
class StaticText
class Subreport
class TextField
Show all
object Element

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Element.type
sealed case class ElementGroup(content: Seq[Element]) extends Element

The only reason to group your report elements is to customize their stretch behavior.

The only reason to group your report elements is to customize their stretch behavior.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
object ElementGroup

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed case class ElementSeq(elements: Seq[Element]) extends Element

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.

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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed case class Ellipse(width: Width, height: Height, x: RestrictedLength, y: YPos, style: AbstractStyle, conditions: Conditions, key: String) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed abstract class EvaluationTime(val value: EvaluationTimeEnum)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Auto
object Band
object Column
class Group
object Now
object Page
object Report
Show all
object EvaluationTime

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
abstract class Expression[+A]

Attributes

See also

See companion object for various functions that return Expression objects.

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Expression

This object provides various ways to create Expression objects.

This object provides various ways to create Expression objects.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Expression.type
sealed case class FloatingBand(band: Band, floating: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class Font(fontName: Option[String], fontSize: Option[Float], bold: Option[Boolean], italic: Option[Boolean], strikeThrough: Option[Boolean], underline: Option[Boolean], pdfEncoding: Option[String], pdfFontName: Option[String], pdfEmbedded: Option[Boolean])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Font

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Font.type
sealed case class Frame(height: Height, content: Element, x: RestrictedLength, y: YPos, width: Width, style: AbstractStyle, conditions: Conditions, key: String) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed case class Group(expression: Expression[Any], header: Seq[Band], footer: Seq[Band], footerPosition: FooterPositionEnum, startNewColumn: Boolean, resetPageNumber: Boolean, reprintHeaderOnEachPage: Boolean, minHeightToStartNewPage: Int, keepTogether: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class Height(value: VerticalLength, stretchType: StretchTypeEnum)

Height of an element

Height of an element

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Height

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Height.type
abstract class Hyperlink

When the user clicks a hyperlink, he or she is redirected to a local destination within the current document or to an external resource.

When the user clicks a hyperlink, he or she is redirected to a local destination within the current document or to an external resource.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Custom
class LocalAnchor
class LocalPage
object None
class Reference
class RemoteAnchor
class RemotePage
Show all
object Hyperlink

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Hyperlink.type
sealed abstract class HyperlinkTarget

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Blank
class Custom
object Parent
object Self
object Top
object HyperlinkTarget

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed case class Image(expression: Expression[Any], width: Width, height: Height, x: RestrictedLength, y: YPos, style: AbstractStyle, conditions: Conditions, key: String, usingCache: Option[Boolean], lazily: Boolean, onError: OnErrorTypeEnum, evaluationTime: EvaluationTime, link: Link, anchor: Anchor) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed abstract class Increment

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Column
class Group
object None
object Page
object Report
object Increment

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Increment.type
sealed case class Line(width: Width, height: Height, x: RestrictedLength, y: YPos, style: AbstractStyle, conditions: Conditions, key: String, direction: LineDirectionEnum) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed case class LineBox(pen: BoxPen, padding: BoxPadding)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LineBox

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
LineBox.type
sealed abstract class LineSpacing

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AtLeast
object Double
class Fixed
object OneAndHalf
class Proportional
object Single
Show all
object LineSpacing

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed case class Link(hyperlink: Hyperlink, target: HyperlinkTarget, tooltip: Option[Expression[String]])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Link

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Link.type
sealed case class Margins(top: RestrictedLength, right: RestrictedLength, bottom: RestrictedLength, left: RestrictedLength)

top and bottom margins can be relative to the page height, left and right relative to the page with

top and bottom margins can be relative to the page height, left and right relative to the page with

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Margins

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Margins.type
sealed case class Page(format: PageFormat, margins: Margins, footer: Option[Band], header: Option[Band], background: Option[Band], columns: Columns)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Page

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Page.type
sealed case class PageFormat(width: Length, height: Length, orientation: OrientationEnum)

Orientation is used mostly to inform printers of page layouts.

Orientation is used mostly to inform printers of page layouts.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PageFormat

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
PageFormat.type
sealed case class Paragraph(lineSpacing: Option[LineSpacing], firstLineIndent: Option[Int], leftIndent: Option[Int], rightIndent: Option[Int], spacingBefore: Option[Int], spacingAfter: Option[Int], tabStopWidth: Option[Int], tabStops: Seq[TabStop])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Paragraph

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Paragraph.type
sealed case class Parameter(name: String, defaultValueExpression: Option[Expression[Any]], isForPrompting: Boolean, nestedTypeName: String, valueClassName: String, description: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class Pen(lineColor: Option[Color], lineStyle: Option[LineStyleEnum], lineWidth: Option[Float])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Pen

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Pen.type
sealed case class Rectangle(width: Width, height: Height, x: RestrictedLength, y: YPos, style: AbstractStyle, conditions: Conditions, key: String) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed case class Report(name: String, details: Seq[Band], defaultStyle: Style, styles: Map[String, Style], templates: IndexedSeq[JRReportTemplate], subDatasets: Map[String, Dataset], mainDataset: Dataset, imports: Set[String], ignorePagination: Boolean, language: String, lastPageFooter: Option[Band], noData: Option[Band], page: Page, summary: Option[SummaryBand], title: Option[TitleBand])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract class Reset

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Column
class Group
object None
object Page
object Report
object Reset

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Reset.type
sealed case class ReturnValue(subreportVariable: String, toVariable: String, calculation: CalculationEnum, incrementerFactoryClassName: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class SortField(name: String, order: SortOrderEnum, fieldType: SortFieldTypeEnum)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class StaticText(text: String, height: Height, width: Width, x: RestrictedLength, y: YPos, key: String, style: AbstractStyle, conditions: Conditions) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed case class Style(parentStyle: Option[StyleReference], conditionalStyles: Seq[(Expression[Boolean], Style)], backcolor: Option[Color], forecolor: Option[Color], font: Font, horizontalImageAlignment: Option[HorizontalImageAlignEnum], horizontalTextAlignment: Option[HorizontalTextAlignEnum], paragraph: Paragraph, markup: Option[String], mode: Option[ModeEnum], pattern: Option[String], radius: Option[Int], rotation: Option[RotationEnum], scaleImage: Option[ScaleImageEnum], verticalImageAlignment: Option[VerticalImageAlignEnum], verticalTextAlignment: Option[VerticalTextAlignEnum], line: Pen, box: LineBox, fill: Option[FillEnum], blankWhenNull: Option[Boolean]) extends AbstractStyle

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Style

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Style.type
sealed case class StyleReference(reference: String) extends AbstractStyle

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class Subreport(subreportExpression: Expression[Any], height: Height, width: Width, x: RestrictedLength, y: YPos, style: AbstractStyle, conditions: Conditions, key: String, arguments: Map[String, Expression[Any]], argumentsMapExpression: Option[Expression[Map[String, AnyRef]]], usingCache: Option[Boolean], dataSourceExpression: Option[Expression[JRDataSource]], connectionExpression: Option[Expression[Connection]], returnValues: Seq[ReturnValue]) extends Element

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
object Subreport

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Subreport.type
sealed case class SummaryBand(band: Band, newPage: Boolean, withPageHeaderAndFooter: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class TabStop(position: Int, align: TabStopAlignEnum)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TabStop

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
TabStop.type
sealed case class TextField(expression: Expression[Any], height: Height, width: Width, x: RestrictedLength, y: YPos, key: String, style: AbstractStyle, conditions: Conditions, link: Link, anchor: Anchor, stretchWithOverflow: Boolean, evaluationTime: EvaluationTime, patternExpression: Option[Expression[Any]]) extends Element

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Element
class Object
trait Matchable
class Any
Show all
sealed case class TitleBand(band: Band, newPage: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed case class Variable(name: String, calculation: CalculationEnum, expression: Expression[Any], valueClassName: String, increment: Increment, reset: Reset, incrementerFactoryClassName: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract class Width

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Remaining
class Specific
object Width

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Width.type
sealed case class YPos(value: VerticalLength, positionType: PositionTypeEnum)

Vertical position of an element

Vertical position of an element

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object YPos

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
YPos.type

Value members

Concrete methods

def compile(r: Report): JasperReport

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.

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.

Attributes

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. This way the overhead can be reduced if many similar reports have to be created for different data.

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.

Attributes

def printJasperReport(jreport: JasperReport, args: Map[String, AnyRef], ds: JRDataSource): JasperPrint

Creates a JasperPrint object of the JasperPrint, optionally specifying a map of named arguments and a datasource

Creates a JasperPrint object of the JasperPrint, optionally specifying a map of named arguments and a datasource

Attributes

Implicits

Implicits

implicit def fractionValue(value: Double): FractionValue
implicit def fractionValue(value: Int): FractionValue
implicit def lengthValue(value: Double): LengthValue
implicit def lengthValue(value: Int): LengthValue
implicit def liftElements(l: Seq[Element]): Element
implicit def specificWidth(value: RestrictedLength): Specific
implicit def specificWidth(value: FractionValue): Specific
implicit def specificWidth(value: Length): Specific
Generated with