GroupBuilder (DynamicReports - core 6.12.0 API)

java.lang.Object
- net.sf.dynamicreports.report.builder.AbstractBuilder<T,DRGroup>
- - net.sf.dynamicreports.report.builder.group.GroupBuilder<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ColumnGroupBuilder, CustomGroupBuilder
```
public abstract class GroupBuilder<T extends GroupBuilder<T>>
extends AbstractBuilder<T,DRGroup>
```
Abstract GroupBuilder class.

Author:

Ricardo Mariaca

See Also:

Serialized Form

Field Summary
- Fields inherited from class net.sf.dynamicreports.report.builder.AbstractBuilder
  builded

Constructor Summary

Constructors
Modifier Constructor and Description

protected GroupBuilder()
Constructor for GroupBuilder.

protected GroupBuilder(String name)
Constructor for GroupBuilder.

Constructors
Modifier	Constructor and Description
`protected`	`GroupBuilder()` Constructor for GroupBuilder.
`protected`	`GroupBuilder(String name)` Constructor for GroupBuilder.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`T`	`addFooterComponent(ComponentBuilder<?,?>... components)` addFooterComponent.
`T`	`addHeaderComponent(ComponentBuilder<?,?>... components)` addHeaderComponent.
`protected void`	`configure()` configure.
`T`	`footer(ComponentBuilder<?,?>... components)` footer.
`DRGroup`	`getGroup()` getGroup.
`T`	`groupByDataType()` groupByDataType.
`T`	`header(ComponentBuilder<?,?>... components)` header.
`T`	`headerWithSubtotal()` headerWithSubtotal.
`T`	`keepTogether()` keepTogether.
`T`	`reprintHeaderOnEachPage()` reprintHeaderOnEachPage.
`T`	`resetPageNumber()` resetPageNumber.
`T`	`setAddToTableOfContents(Boolean addToTableOfContents)` setAddToTableOfContents.
`T`	`setFooterBackgroundComponent(ComponentBuilder<?,?> backgroundComponent)` setFooterBackgroundComponent.
`T`	`setFooterPosition(GroupFooterPosition footerPosition)` setFooterPosition.
`T`	`setFooterPrintWhenExpression(DRIExpression<Boolean> printWhenExpression)` setFooterPrintWhenExpression.
`T`	`setFooterSplitType(SplitType splitType)` setFooterSplitType.
`T`	`setFooterStyle(ReportStyleBuilder style)` setFooterStyle.
`T`	`setGroupByDataType(Boolean groupByDataType)` setGroupByDataType.
`T`	`setHeaderBackgroundComponent(ComponentBuilder<?,?> backgroundComponent)` setHeaderBackgroundComponent.
`T`	`setHeaderLayout(GroupHeaderLayout headerLayout)` setHeaderLayout.
`T`	`setHeaderPrintWhenExpression(DRIExpression<Boolean> printWhenExpression)` setHeaderPrintWhenExpression.
`T`	`setHeaderSplitType(SplitType splitType)` setHeaderSplitType.
`T`	`setHeaderStyle(ReportStyleBuilder style)` setHeaderStyle.
`T`	`setHeaderWithSubtotal(Boolean headerWithSubtotal)` setHeaderWithSubtotal.
`T`	`setHorizontalAlignment(HorizontalAlignment horizontalAlignment)` Deprecated. use setHorizontalTextAlignment instead
`T`	`setHorizontalTextAlignment(HorizontalTextAlignment horizontalTextAlignment)` setHorizontalTextAlignment.
`T`	`setKeepTogether(Boolean keepTogether)` setKeepTogether.
`T`	`setMinHeightToStartNewPage(Integer minHeightToStartNewPage)` setMinHeightToStartNewPage.
`T`	`setPadding(Integer padding)` setPadding.
`T`	`setPrintSubtotalsWhenExpression(DRIExpression<Boolean> printSubtotalsWhenExpression)` setPrintSubtotalsWhenExpression.
`T`	`setReprintHeaderOnEachPage(Boolean reprintHeaderOnEachPage)` setReprintHeaderOnEachPage.
`T`	`setResetPageNumber(Boolean resetPageNumber)` setResetPageNumber.
`T`	`setShowColumnHeaderAndFooter(Boolean showColumnHeaderAndFooter)` setShowColumnHeaderAndFooter.
`T`	`setStartInNewColumn(Boolean startInNewColumn)` setStartInNewColumn.
`T`	`setStartInNewPage(Boolean startInNewPage)` setStartInNewPage.
`T`	`setStyle(ReportStyleBuilder style)` setStyle.
`T`	`setTitleStyle(ReportStyleBuilder titleStyle)` setTitleStyle.
`T`	`setTitleWidth(Integer titleWidth)` setTitleWidth.
`protected void`	`setValueExpression(DRIExpression<?> valueExpression)` Setter for the field `valueExpression`.
`T`	`showColumnHeaderAndFooter()` showColumnHeaderAndFooter.
`T`	`startInNewColumn()` startInNewColumn.
`T`	`startInNewPage()` startInNewPage.

Methods inherited from class net.sf.dynamicreports.report.builder.AbstractBuilder
build, getObject

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroupBuilder
```
protected GroupBuilder()
```
    Constructor for GroupBuilder.
  - GroupBuilder
```
protected GroupBuilder(String name)
```
    Constructor for GroupBuilder.
    
    Parameters:
    
    name - a String object.
- Method Detail
  - setValueExpression
```
protected void setValueExpression(DRIExpression<?> valueExpression)
```
    Setter for the field valueExpression.
    
    Parameters:
    
    valueExpression - a DRIExpression object.
  - setHeaderLayout
```
public T setHeaderLayout(GroupHeaderLayout headerLayout)
```
    setHeaderLayout.
    
    Parameters:
    
    headerLayout - a GroupHeaderLayout object.
    
    Returns:
    
    a T object.
  - showColumnHeaderAndFooter
```
public T showColumnHeaderAndFooter()
```
    showColumnHeaderAndFooter.
    
    Returns:
    
    a T object.
  - setShowColumnHeaderAndFooter
```
public T setShowColumnHeaderAndFooter(Boolean showColumnHeaderAndFooter)
```
    setShowColumnHeaderAndFooter.
    
    Parameters:
    
    showColumnHeaderAndFooter - a Boolean object.
    
    Returns:
    
    a T object.
  - setAddToTableOfContents
```
public T setAddToTableOfContents(Boolean addToTableOfContents)
```
    setAddToTableOfContents.
    
    Parameters:
    
    addToTableOfContents - a Boolean object.
    
    Returns:
    
    a T object.
  - setPrintSubtotalsWhenExpression
```
public T setPrintSubtotalsWhenExpression(DRIExpression<Boolean> printSubtotalsWhenExpression)
```
    setPrintSubtotalsWhenExpression.
    
    Parameters:
    
    printSubtotalsWhenExpression - a DRIExpression object.
    
    Returns:
    
    a T object.
  - setPadding
```
public T setPadding(Integer padding)
```
    setPadding.
    
    Parameters:
    
    padding - a Integer object.
    
    Returns:
    
    a T object.
  - startInNewPage
```
public T startInNewPage()
```
    startInNewPage.
    
    Returns:
    
    a T object.
  - setStartInNewPage
```
public T setStartInNewPage(Boolean startInNewPage)
```
    setStartInNewPage.
    
    Parameters:
    
    startInNewPage - a Boolean object.
    
    Returns:
    
    a T object.
  - startInNewColumn
```
public T startInNewColumn()
```
    startInNewColumn.
    
    Returns:
    
    a T object.
  - setStartInNewColumn
```
public T setStartInNewColumn(Boolean startInNewColumn)
```
    setStartInNewColumn.
    
    Parameters:
    
    startInNewColumn - a Boolean object.
    
    Returns:
    
    a T object.
  - reprintHeaderOnEachPage
```
public T reprintHeaderOnEachPage()
```
    reprintHeaderOnEachPage.
    
    Returns:
    
    a T object.
  - setReprintHeaderOnEachPage
```
public T setReprintHeaderOnEachPage(Boolean reprintHeaderOnEachPage)
```
    setReprintHeaderOnEachPage.
    
    Parameters:
    
    reprintHeaderOnEachPage - a Boolean object.
    
    Returns:
    
    a T object.
  - resetPageNumber
```
public T resetPageNumber()
```
    resetPageNumber.
    
    Returns:
    
    a T object.
  - setResetPageNumber
```
public T setResetPageNumber(Boolean resetPageNumber)
```
    setResetPageNumber.
    
    Parameters:
    
    resetPageNumber - a Boolean object.
    
    Returns:
    
    a T object.
  - setMinHeightToStartNewPage
```
public T setMinHeightToStartNewPage(Integer minHeightToStartNewPage)
```
    setMinHeightToStartNewPage.
    
    Parameters:
    
    minHeightToStartNewPage - a Integer object.
    
    Returns:
    
    a T object.
  - setFooterPosition
```
public T setFooterPosition(GroupFooterPosition footerPosition)
```
    setFooterPosition.
    
    Parameters:
    
    footerPosition - a GroupFooterPosition object.
    
    Returns:
    
    a T object.
  - keepTogether
```
public T keepTogether()
```
    keepTogether.
    
    Returns:
    
    a T object.
  - setKeepTogether
```
public T setKeepTogether(Boolean keepTogether)
```
    setKeepTogether.
    
    Parameters:
    
    keepTogether - a Boolean object.
    
    Returns:
    
    a T object.
  - headerWithSubtotal
```
public T headerWithSubtotal()
```
    headerWithSubtotal.
    
    Returns:
    
    a T object.
  - setHeaderWithSubtotal
```
public T setHeaderWithSubtotal(Boolean headerWithSubtotal)
```
    setHeaderWithSubtotal.
    
    Parameters:
    
    headerWithSubtotal - a Boolean object.
    
    Returns:
    
    a T object.
  - groupByDataType
```
public T groupByDataType()
```
    groupByDataType.
    
    Returns:
    
    a T object.
  - setGroupByDataType
```
public T setGroupByDataType(Boolean groupByDataType)
```
    setGroupByDataType.
    
    Parameters:
    
    groupByDataType - a Boolean object.
    
    Returns:
    
    a T object.
  - setStyle
```
public T setStyle(ReportStyleBuilder style)
```
    setStyle.
    
    Parameters:
    
    style - a ReportStyleBuilder object.
    
    Returns:
    
    a T object.
  - setHorizontalAlignment
```
@Deprecated
public T setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
```
    Deprecated. use setHorizontalTextAlignment instead
    
    setHorizontalAlignment.
    
    Parameters:
    
    horizontalAlignment - a HorizontalAlignment object.
    
    Returns:
    
    a T object.
  - setHorizontalTextAlignment
```
public T setHorizontalTextAlignment(HorizontalTextAlignment horizontalTextAlignment)
```
    setHorizontalTextAlignment.
    
    Parameters:
    
    horizontalTextAlignment - a HorizontalTextAlignment object.
    
    Returns:
    
    a T object.
  - setTitleStyle
```
public T setTitleStyle(ReportStyleBuilder titleStyle)
```
    setTitleStyle.
    
    Parameters:
    
    titleStyle - a ReportStyleBuilder object.
    
    Returns:
    
    a T object.
  - setTitleWidth
```
public T setTitleWidth(Integer titleWidth)
```
    setTitleWidth.
    
    Parameters:
    
    titleWidth - a Integer object.
    
    Returns:
    
    a T object.
  - setHeaderSplitType
```
public T setHeaderSplitType(SplitType splitType)
```
    setHeaderSplitType.
    
    Parameters:
    
    splitType - a SplitType object.
    
    Returns:
    
    a T object.
  - setHeaderPrintWhenExpression
```
public T setHeaderPrintWhenExpression(DRIExpression<Boolean> printWhenExpression)
```
    setHeaderPrintWhenExpression.
    
    Parameters:
    
    printWhenExpression - a DRIExpression object.
    
    Returns:
    
    a T object.
  - setHeaderStyle
```
public T setHeaderStyle(ReportStyleBuilder style)
```
    setHeaderStyle.
    
    Parameters:
    
    style - a ReportStyleBuilder object.
    
    Returns:
    
    a T object.
  - setHeaderBackgroundComponent
```
public T setHeaderBackgroundComponent(ComponentBuilder<?,?> backgroundComponent)
```
    setHeaderBackgroundComponent.
    
    Parameters:
    
    backgroundComponent - a ComponentBuilder object.
    
    Returns:
    
    a T object.
  - addHeaderComponent
```
public T addHeaderComponent(ComponentBuilder<?,?>... components)
```
    addHeaderComponent.
    
    Parameters:
    
    components - a ComponentBuilder object.
    
    Returns:
    
    a T object.
  - header
```
public T header(ComponentBuilder<?,?>... components)
```
    header.
    
    Parameters:
    
    components - a ComponentBuilder object.
    
    Returns:
    
    a T object.
  - setFooterSplitType
```
public T setFooterSplitType(SplitType splitType)
```
    setFooterSplitType.
    
    Parameters:
    
    splitType - a SplitType object.
    
    Returns:
    
    a T object.
  - setFooterPrintWhenExpression
```
public T setFooterPrintWhenExpression(DRIExpression<Boolean> printWhenExpression)
```
    setFooterPrintWhenExpression.
    
    Parameters:
    
    printWhenExpression - a DRIExpression object.
    
    Returns:
    
    a T object.
  - setFooterStyle
```
public T setFooterStyle(ReportStyleBuilder style)
```
    setFooterStyle.
    
    Parameters:
    
    style - a ReportStyleBuilder object.
    
    Returns:
    
    a T object.
  - setFooterBackgroundComponent
```
public T setFooterBackgroundComponent(ComponentBuilder<?,?> backgroundComponent)
```
    setFooterBackgroundComponent.
    
    Parameters:
    
    backgroundComponent - a ComponentBuilder object.
    
    Returns:
    
    a T object.
  - addFooterComponent
```
public T addFooterComponent(ComponentBuilder<?,?>... components)
```
    addFooterComponent.
    
    Parameters:
    
    components - a ComponentBuilder object.
    
    Returns:
    
    a T object.
  - footer
```
public T footer(ComponentBuilder<?,?>... components)
```
    footer.
    
    Parameters:
    
    components - a ComponentBuilder object.
    
    Returns:
    
    a T object.
  - configure
```
protected void configure()
```
    configure.
    
    Overrides:
    
    configure in class AbstractBuilder<T extends GroupBuilder<T>,DRGroup>
  - getGroup
```
public DRGroup getGroup()
```
    getGroup.
    
    Returns:
    
    a DRGroup object.

Class GroupBuilder<T extends GroupBuilder<T>>

Field Summary

Fields inherited from class net.sf.dynamicreports.report.builder.AbstractBuilder

Constructor Summary

Method Summary

Methods inherited from class net.sf.dynamicreports.report.builder.AbstractBuilder

Methods inherited from class java.lang.Object

Constructor Detail

GroupBuilder

GroupBuilder

Method Detail

setValueExpression

setHeaderLayout

showColumnHeaderAndFooter

setShowColumnHeaderAndFooter

setAddToTableOfContents

setPrintSubtotalsWhenExpression

setPadding

startInNewPage

setStartInNewPage

startInNewColumn

setStartInNewColumn

reprintHeaderOnEachPage

setReprintHeaderOnEachPage

resetPageNumber

setResetPageNumber

setMinHeightToStartNewPage

setFooterPosition

keepTogether

setKeepTogether

headerWithSubtotal

setHeaderWithSubtotal

groupByDataType

setGroupByDataType

setStyle

setHorizontalAlignment

setHorizontalTextAlignment

setTitleStyle

setTitleWidth

setHeaderSplitType

setHeaderPrintWhenExpression

setHeaderStyle

setHeaderBackgroundComponent

addHeaderComponent

header

setFooterSplitType

setFooterPrintWhenExpression

setFooterStyle

setFooterBackgroundComponent

addFooterComponent

footer

configure

getGroup