net.sf.jasperreports.components.list
public class StandardListComponent extends java.lang.Object implements java.io.Serializable, ListComponent, JRChangeEventsSupport
ListComponent
implementation.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PROPERTY_IGNORE_WIDTH |
static java.lang.String |
PROPERTY_PRINT_ORDER |
Constructor and Description |
---|
StandardListComponent() |
StandardListComponent(ListComponent list,
JRBaseObjectFactory baseFactory) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
ListContents |
getContents()
Returns the list item contents.
|
JRDatasetRun |
getDatasetRun()
Returns the subdataset run information that will be used by this list.
|
JRPropertyChangeSupport |
getEventSupport()
Returns the property change support object for this instance.
|
java.lang.Boolean |
getIgnoreWidth()
Returns the flag that determines whether the element width is to be ignored
when filling this list.
|
java.lang.Byte |
getPrintOrder()
Deprecated.
Replaced by
getPrintOrderValue() . |
PrintOrderEnum |
getPrintOrderValue()
Returns the print order of the list cells.
|
void |
setContents(ListContents contents)
Sets the list item contents.
|
void |
setDatasetRun(JRDatasetRun datasetRun)
Sets the subdataset run information that will be used by this list.
|
void |
setIgnoreWidth(boolean ignoreWidth)
Sets the list ignore width flag.
|
void |
setIgnoreWidth(java.lang.Boolean ignoreWidth)
Sets the list ignore width flag.
|
void |
setPrintOrder(byte printOrder)
Deprecated.
Replaced by
setPrintOrderValue(PrintOrderEnum) . |
void |
setPrintOrder(java.lang.Byte printOrder)
Deprecated.
Replaced by
setPrintOrderValue(PrintOrderEnum) . |
void |
setPrintOrderValue(PrintOrderEnum printOrderValue)
Sets the list cell print order.
|
public static final java.lang.String PROPERTY_PRINT_ORDER
public static final java.lang.String PROPERTY_IGNORE_WIDTH
public StandardListComponent()
public StandardListComponent(ListComponent list, JRBaseObjectFactory baseFactory)
public JRDatasetRun getDatasetRun()
ListComponent
This information is required to instantiate a subdataset from the report. The data produced by the subdataset is fed to the list item contents.
getDatasetRun
in interface ListComponent
public void setDatasetRun(JRDatasetRun datasetRun)
datasetRun
- the subdataset run informationgetDatasetRun()
public ListContents getContents()
ListComponent
Each record produced by the list subdataset is used to fill the list item contents and the result is included in the generated report.
getContents
in interface ListComponent
public void setContents(ListContents contents)
contents
- the list item contentsgetContents()
public java.lang.Object clone()
clone
in interface JRCloneable
clone
in class java.lang.Object
public java.lang.Byte getPrintOrder()
getPrintOrderValue()
.getPrintOrder
in interface ListComponent
public PrintOrderEnum getPrintOrderValue()
ListComponent
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.
getPrintOrderValue
in interface ListComponent
ListContents.getWidth()
public void setPrintOrder(java.lang.Byte printOrder)
setPrintOrderValue(PrintOrderEnum)
.public void setPrintOrder(byte printOrder)
setPrintOrderValue(PrintOrderEnum)
.public void setPrintOrderValue(PrintOrderEnum printOrderValue)
printOrderValue
- the cell print oder, null or one of
getPrintOrderValue()
public JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupport
getEventSupport
in interface JRChangeEventsSupport
public java.lang.Boolean getIgnoreWidth()
ListComponent
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.
getIgnoreWidth
in interface ListComponent
ListComponent.getPrintOrder()
,
JRCrosstab.setIgnoreWidth(Boolean)
public void setIgnoreWidth(java.lang.Boolean ignoreWidth)
ignoreWidth
- the ignore width flagpublic void setIgnoreWidth(boolean ignoreWidth)
ignoreWidth
- the ignore width flag© 2001-2010 Jaspersoft Corporation www.jaspersoft.com