|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.FixedContainer
inetsoft.report.SectionBand
public class SectionBand
A SectionBand contains the elements in a section frame. The section frame always takes the entire page width, with the specified height. All elements in a frame are drawn at fixed position and size relative to the frame.
A section band can be declared as 'Shrink to Fit'. If this is true, the height of the band could shrink if the elements in the band does not use its occupied space. This is normally used to handle elements with wide range of size. Those elements can be allocated a large size at design time. The band will dynamically adjust its height to adopt to the actual element size.
A section band can also contain a subreport. A subreport is a complete report embedded inside a section. Section band fields can be used to supply subreport parameter values. The subreport is printed inside a band. The band automatically grows with the subreport, and could potentially span across multiple pages.
| Nested Class Summary | |
|---|---|
static class |
SectionBand.Separator
Separator is used for describe a vertical seperator in section. |
| Field Summary |
|---|
| Fields inherited from class inetsoft.report.FixedContainer |
|---|
parent |
| Constructor Summary | |
|---|---|
SectionBand(ReportSheet report)
Create a section band. |
|
| Method Summary | |
|---|---|
String |
addSubreport(ReportSheet subreport,
String[][] binding,
Rectangle bounds)
Add a subreport to this section band. |
String |
addText(String binding,
String text,
Rectangle bounds)
Add a text element to the document. |
String |
addTextBox(String binding,
String text,
int border,
int textalign,
Rectangle bounds)
Add a text box to the document. |
Object |
clone()
|
void |
collapse()
Collapse the band. |
void |
expand()
Expand the band. |
void |
forceBreakable()
Force the band to be breakable. |
Color |
getBackground()
Return the section band background. |
String |
getBinding(String id)
Get the binding of a field. |
int |
getBottomBorder()
Get the section band bottom border style. |
Color |
getBottomBorderColor()
Get the section band bottom border color. |
GroupableCellBinding |
getCellBinding(String id)
Get cell binding. |
Enumeration |
getFields()
Get the names of the fields bound to elements in this band. |
float |
getHeight()
Get the height of the frame. |
int |
getLeftBorder()
Get the section band left border style. |
Color |
getLeftBorderColor()
Get the section band left border color. |
int |
getRightBorder()
Get the section band right border style. |
Color |
getRightBorderColor()
Get the section band right border color. |
int |
getTopBorder()
Get the section band top border style. |
Color |
getTopBorderColor()
Get the section band top border color. |
Object |
getValue(String id)
Get the raw value of an element. |
boolean |
isAtBottom()
Check if this section band should be printed at the bottom of a page. |
boolean |
isBound(String field)
Check if a field is ever bound in this section band. |
boolean |
isBreakable()
Check if this band can be broken into regions across page boundary. |
boolean |
isCollapsed()
Check whether the band is collapsed. |
boolean |
isForceBreakable()
Check whether the band was force to be broken. |
boolean |
isForceNewPage()
Check if force a new page before or after this band is printed. |
boolean |
isKeepTogether()
Check whether to keep group bands together. |
boolean |
isOrphanControl()
Check the current widow/orphan control setting. |
boolean |
isPageAfter()
Check if a new page should be advanced to after this band is printed. |
boolean |
isPageBefore()
Check if this band should always start at the top of a page. |
boolean |
isPrintable()
Check if this band is visible. |
boolean |
isRepeatHeader()
Check if this band should be repeated at top of every page the group is printed. |
boolean |
isSheetAfter()
Check if a new sheet should be advanced to after this band is export. |
boolean |
isSheetBefore()
Check if this band should always start at the top of a sheet. |
boolean |
isShrinkToFit()
Get the shrink to fit option. |
boolean |
isSuppressBlank()
Check if blank section band is suppressed. |
boolean |
isUnderlay()
Check if this band should underlay the subsequent bands. |
boolean |
isVisible()
Check if this band is visible. |
void |
removeAllElements()
Remove all elements. |
void |
removeAllValues()
Remove all field values stored in the band. |
void |
removeElement(String id)
Remove the specified element. |
void |
reset()
Reset the internal state so it's ready for next printing. |
void |
reset(boolean continued)
This method selectively calls reset() only when a band is continued on the next page. |
void |
resetForceBreakable()
Reset the band to not be force broken. |
void |
setAtBottom(boolean bottom)
Set whether this section band should be printed at the bottom of a page. |
void |
setBackground(Color bg)
Set the section band background. |
void |
setBinding(String id,
String field)
Set the binding of a field element. |
void |
setBottomBorder(int border)
Set the section band bottom border line style. |
void |
setBottomBorderColor(Color border)
Set the section band bottom border line color. |
void |
setBreakable(boolean breakable)
Control if a band can span across pages. |
void |
setCellBinding(String id,
GroupableCellBinding binding)
Set binding for the element. |
void |
setElement(int idx,
ReportElement elem)
Replace an element at the specified position. |
void |
setForceNewPage(boolean force)
Set whether force a new page before or after this band is printed. |
void |
setHeight(float inch)
Set the frame height. |
void |
setKeepTogether(boolean keepTogether)
Set whether to keep group bands together. |
void |
setLeftBorder(int border)
Set the section band left border line style. |
void |
setLeftBorderColor(Color border)
Set the section band left border line color. |
void |
setOrphanControl(boolean orphan)
Set the section widow/orphan control option. |
void |
setPageAfter(boolean pg)
Set whether a new page should be advanced to after this band is printed. |
void |
setPageBefore(boolean pg)
Set whether a new page should be advanced to before this band is printed. |
void |
setPresenter(String id,
Presenter presenter)
Set a presenter for an element. |
void |
setRepeatHeader(boolean flag)
Set whether this band should be repeated at top of every page. |
void |
setRightBorder(int border)
Set the section band right border line style. |
void |
setRightBorderColor(Color border)
Set the section band right border line color. |
void |
setSheetAfter(boolean sheetAfter)
Set whether a new sheet should be advanced to after this band is export. |
void |
setSheetBefore(boolean sheetBefore)
Set whether a new sheet should be advanced to before this band is export. |
void |
setShrinkToFit(boolean shrink)
Set shrink to fit option. |
void |
setSuppressBlank(boolean suppressBlank)
Set suppress blank section band option. |
void |
setTopBorder(int border)
Set the section band top border line style. |
void |
setTopBorderColor(Color border)
Set the section band top border line color. |
void |
setUnderlay(boolean underlay)
Set whether this band should underlay the subsequent bands. |
void |
setValue(String id,
Object val)
Save the original value of an element. |
void |
setVisible(boolean vis)
Show or hide this band. |
String |
toString()
Get the string representation. |
| Methods inherited from class inetsoft.report.FixedContainer |
|---|
addBean, addBullet, addBullet, addChart, addComponent, addElement, addElement, addForm, addImage, addPainter, addSeparator, addShape, addTab, addTable, addText, addText, addTextBox, addTextBox, addTextBox, addTOC, elements, elements, getBounds, getElement, getElement, getElementCount, getElementIndex, getElementIndex, getPrintBounds, getReport, getShape, getShapeCount, getShapeIndex, getVSeparator, getVSeparators, removeElement, removeShape, setBounds, setPrintBounds, setReport, setVSeparator, setVSeparators |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public SectionBand(ReportSheet report)
report - the report this band is associated with.| Method Detail |
|---|
public float getHeight()
public void setHeight(float inch)
inch - frame height in inches.public boolean isShrinkToFit()
public void setShrinkToFit(boolean shrink)
public boolean isRepeatHeader()
public void setRepeatHeader(boolean flag)
public boolean isUnderlay()
public void setUnderlay(boolean underlay)
public boolean isAtBottom()
public void setAtBottom(boolean bottom)
public boolean isKeepTogether()
public void setKeepTogether(boolean keepTogether)
public void setOrphanControl(boolean orphan)
orphan - true to eliminate widow/orphan header/footer.public boolean isOrphanControl()
public boolean isSuppressBlank()
public void setSuppressBlank(boolean suppressBlank)
public boolean isBreakable()
public void setBreakable(boolean breakable)
breakable - true to enable spanning across pages.public String getBinding(String id)
id - field element ID.
public void setBinding(String id,
String field)
id - element ID.field - binding field.
public void setCellBinding(String id,
GroupableCellBinding binding)
public GroupableCellBinding getCellBinding(String id)
public boolean isBound(String field)
public void removeAllElements()
removeAllElements in class FixedContainerpublic Object getValue(String id)
public void setValue(String id,
Object val)
public Enumeration getFields()
public void removeAllValues()
public boolean isVisible()
public void setVisible(boolean vis)
vis - false to hide this band.public boolean isPrintable()
public boolean isPageBefore()
public void setPageBefore(boolean pg)
public boolean isPageAfter()
public void setPageAfter(boolean pg)
public boolean isSheetBefore()
public void setSheetBefore(boolean sheetBefore)
public boolean isSheetAfter()
public void setSheetAfter(boolean sheetAfter)
public boolean isForceNewPage()
public void setForceNewPage(boolean force)
public Color getBackground()
public void setBackground(Color bg)
public int getTopBorder()
public void setTopBorder(int border)
public int getLeftBorder()
public void setLeftBorder(int border)
public int getBottomBorder()
public void setBottomBorder(int border)
public int getRightBorder()
public void setRightBorder(int border)
public Color getTopBorderColor()
public void setTopBorderColor(Color border)
public Color getLeftBorderColor()
public void setLeftBorderColor(Color border)
public Color getBottomBorderColor()
public void setBottomBorderColor(Color border)
public Color getRightBorderColor()
public void setRightBorderColor(Color border)
public String addText(String binding,
String text,
Rectangle bounds)
binding - the column the element is bound to.text - text string.
public String addTextBox(String binding,
String text,
int border,
int textalign,
Rectangle bounds)
binding - the column the element is bound to.text - text content.border - border line style. One of the line styles defined in
the StyleConstants class.textalign - text alignment within the box.
public String addSubreport(ReportSheet subreport,
String[][] binding,
Rectangle bounds)
subreport - subreport object.binding - this is a two dimensional array. Each row in the array
must be a two element pair. The first value in the pair is the name
of a subreport parameter, the second value is a name of a table
column bound to this band, or the name of an element in this band.
The column or element value is used as the corresponding parameter
value.
public void setPresenter(String id,
Presenter presenter)
public void removeElement(String id)
id - element id.
public void setElement(int idx,
ReportElement elem)
setElement in class FixedContainerpublic Object clone()
clone in class FixedContainerpublic void expand()
public void collapse()
public boolean isCollapsed()
public void forceBreakable()
public void resetForceBreakable()
public boolean isForceBreakable()
public void reset(boolean continued)
continued - Specifies if continued at top of next pagepublic void reset()
reset in class FixedContainerpublic String toString()
toString in class Object
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||