protected AbstractElementFormatFunction() 
{

}

Creates an unnamed function. Make sure the name of the function is set using #setName before the function is added to the report's function collection.

 public String getElement() 
{
    return element;
}

Returns the element name.

 public Object getValue() 
{
    return null;
}

Format-Functions usually are not expected to return anything.

 public  void groupFinished(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final Band b = FunctionUtilities.getCurrentGroup(event).getFooter();
    processRootBand(b);
    processFooterBands(event.getState());
}

Processes the group footer of the current group.

 public  void groupStarted(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final Group group = FunctionUtilities.getCurrentGroup(event);
    processGroup(group);
    processFooterBands(event.getState());
}

Processes the group header of the current group.

 public  void itemsAdvanced(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final Band b = event.getReport().getItemBand();
    processRootBand(b);
    processFooterBands(event.getState());
}

Processes the ItemBand.

 public  void itemsFinished(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final ReportDefinition definition = event.getReport();
    processRootBand(definition.getDetailsFooter());
    processFooterBands(event.getState());
}

Receives notification that a group of item bands has been completed.

The itemBand is finished, the report starts to close open groups.

 public  void itemsStarted(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final ReportDefinition definition = event.getReport();
    processRootBand(definition.getNoDataBand());
    processRootBand(definition.getDetailsHeader());
    processFooterBands(event.getState());
}

Processes the No-Data-Band.

 public  void pageFinished(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final Band b = event.getReport().getPageFooter();
    processRootBand(b);
}

Processes the page footer.

 public  void pageStarted(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final Band b = event.getReport().getPageHeader();
    processRootBand(b);
    final Band w = event.getReport().getWatermark();
    processRootBand(w);
    processFooterBands(event.getState());
}

Processes the page header.

 protected  void processFooterBands(ReportState state) 
{
    while (state != null)
    {
      final ReportDefinition reportDefinition = state.getReport();
      processRootBand(reportDefinition.getPageFooter());
      processRootBand(reportDefinition.getDetailsFooter());
      Group g = reportDefinition.getRootGroup();
      while (g != null)
      {
        processRootBand(g.getFooter());
        final GroupBody body = g.getBody();
        if (body instanceof SubGroupBody == false)
        {
          break;
        }
        final SubGroupBody sgb = (SubGroupBody) body;
        g = sgb.getGroup();
      }
      state = state.getParentSubReportState();
    }
}

 protected  void processGroup(Group group) 
{
    final Band b = group.getHeader();
    processRootBand(b);
}

 abstract protected  void processRootBand(Band b)
Processes the root band for the current event. This method must be implemented by all subclasses and contains all
code necessary to update the style or structure of the given band. The update must be deterministic, calls must
result in the same layout for all calls for a given report processing state.

 public  void reportFinished(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final Band b = event.getReport().getReportFooter();
    processRootBand(b);
    processFooterBands(event.getState());
}

Processes the Report-Footer.

 public  void reportInitialized(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final boolean slottedHeaderMode =
        ("slotted".equals(getRuntime().getConfiguration().getConfigProperty
            ("org.jfree.report.layout.HeaderPageBandMode", "slotted")));
    if (slottedHeaderMode)
    {
      final Band b = event.getReport().getPageHeader();
      processRootBand(b);
    }
}

Receives notification that report generation initializes the current run.

The event carries a ReportState.Started state. Use this to initialize the report.

 public  void reportStarted(ReportEvent event) 
{
    if (FunctionUtilities.isLayoutLevel(event) == false)
    {
      // dont do anything if there is no printing done ...
      return;
    }
    final Band b = event.getReport().getReportHeader();
    processRootBand(b);
    processFooterBands(event.getState());
}

Processes the Report-Header.

 public  void setElement(String name) 
{
    this.element = name;
}

Sets the element name. The name denotes an element or band within the root-band or the root-band itself. It is possible to define multiple elements with the same name to apply the modification to all of these elements.