Package net.sf.jasperreports.components.list

Class StandardListComponent

java.lang.Object
net.sf.jasperreports.components.list.StandardListComponent
All Implemented Interfaces:
Serializable, Cloneable, ListComponent, Component, DatasetRunHolder, JRChangeEventsSupport, JRCloneable, JRVisitable
public class StandardListComponent extends Object implements Serializable, ListComponent, JRChangeEventsSupport
Standard ListComponent implementation.
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

    • StandardListComponent

      public StandardListComponent()

    • StandardListComponent

      public StandardListComponent(ListComponent list, JRBaseObjectFactory baseFactory)

  • Method Details

    • getDatasetRun

      public JRDatasetRun getDatasetRun()
      Description copied from interface: ListComponent
      Returns the subdataset run information that will be used by this list.

      This information is required to instantiate a subdataset from the report. The data produced by the subdataset is fed to the list item contents.

      Specified by:
      getDatasetRun in interface DatasetRunHolder
      Specified by:
      getDatasetRun in interface ListComponent
      Returns:
      the subdataset run information

    • setDatasetRun

      public void setDatasetRun(JRDatasetRun datasetRun)
      Sets the subdataset run information that will be used by this list.
      Parameters:
      datasetRun - the subdataset run information
      See Also:

    • getContents

      public ListContents getContents()
      Description copied from interface: ListComponent
      Returns the list item contents.

      Each record produced by the list subdataset is used to fill the list item contents and the result is included in the generated report.

      Specified by:
      getContents in interface ListComponent
      Returns:
      the list item contents

    • setContents

      public void setContents(ListContents contents)
      Sets the list item contents.
      Parameters:
      contents - the list item contents
      See Also:

    • clone

      public Object clone()
      Specified by:
      clone in interface JRCloneable
      Overrides:
      clone in class Object

    • getPrintOrder

      public PrintOrderEnum getPrintOrder()
      Description copied from interface: ListComponent
      Returns the print order of the list cells.

      The list cells can be either printed vertically one beneath another (on a single column), or horizontally on rows of 2 or more columns.

      The default print order (used when no explicit order has been set) is vertical.

      Specified by:
      getPrintOrder in interface ListComponent
      Returns:
      the list print order if set, one of
      See Also:

    • setPrintOrder

      public void setPrintOrder(PrintOrderEnum printOrder)
      Sets the list cell print order.
      Parameters:
      printOrder - the cell print oder, null or one of
      See Also:

    • getEventSupport

      public JRPropertyChangeSupport getEventSupport()
      Description copied from interface: JRChangeEventsSupport
      Returns the property change support object for this instance.
      Specified by:
      getEventSupport in interface JRChangeEventsSupport
      Returns:
      the property change support object for this instance

    • getIgnoreWidth

      public Boolean getIgnoreWidth()
      Description copied from interface: ListComponent
      Returns the flag that determines whether the element width is to be ignored when filling this list.

      This flag only applies to horizontally filled reports. If the flag is set, the list will be filled on a single row.

      By default, the flag is not set.

      Specified by:
      getIgnoreWidth in interface ListComponent
      See Also:

    • setIgnoreWidth

      public void setIgnoreWidth(Boolean ignoreWidth)
      Sets the list ignore width flag.
      Parameters:
      ignoreWidth - the ignore width flag

    • setIgnoreWidth

      public void setIgnoreWidth(boolean ignoreWidth)
      Sets the list ignore width flag.
      Parameters:
      ignoreWidth - the ignore width flag

    • visit

      public void visit(JRVisitor visitor)
      Specified by:
      visit in interface JRVisitable