|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.lens.ElementContainer
public class ElementContainer
A container can be added to a report template in report designer. The container can later be populated with elements dynamically. This provides an easy way to combine static templates with dynamically created report contents.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface inetsoft.report.CompositeLens |
|---|
CompositeLens.Separator, CompositeLens.Space, CompositeLens.Tab |
| Field Summary | |
|---|---|
protected ReportSheet |
parent
|
| Fields inherited from interface inetsoft.report.CompositeLens |
|---|
AREA_BREAK, BREAK, NEWLINE, PAGE_BREAK |
| Constructor Summary | |
|---|---|
ElementContainer(ReportSheet parent)
|
|
| Method Summary | |
|---|---|
String |
addAreaBreak()
Add a area break to the document. |
String |
addBean(String name)
Add a bean to the report. |
String |
addBreak()
Add a break to the document. |
String |
addBullet()
Add a bullet to the document. |
String |
addBullet(Image icon)
Add a bullet with user specified image as bullet icon. |
void |
addButton(String form,
String name,
String text)
Add a form button to the report. |
void |
addButton(String form,
String name,
String script,
String text)
Add a form button to the report. |
String |
addChart(DataSet chart)
Add a chart to the report. |
String |
addChart(DataSet chart,
double winch,
double hinch)
This is same as addChart() exception an explicit size of the chart area is specified. |
void |
addCheckBox(String form,
String name,
String text,
boolean selected)
Add a checkbox to the report. |
void |
addCheckBox(String form,
String name,
String script,
String text,
boolean selected)
Add a checkbox to the report. |
void |
addChoiceElement(String form,
String name,
String selected,
String[] choices)
Add a choice field to the report. |
void |
addChoiceElement(String form,
String name,
String script,
String selected,
String[] choices)
Add a choice field to the report. |
String |
addComponent(Component comp)
Add an AWT component to the document. |
String |
addComponent(Component component,
double winch,
double hinch)
This is same as addComponent() exception an explicit size of the painter area is specified. |
String |
addConditionalPageBreak(double inch)
Add a conditional page break. |
String |
addConditionalPageBreak(int min)
Add a conditional page break. |
void |
addDateCombo(String form,
String name,
Date date)
Add a datecombo to a report. |
void |
addDateCombo(String form,
String name,
String script,
Date date)
Add a datecombo to a report. |
String |
addElement(ReportElement e)
Add an element to the document. |
String |
addForm(FormLens form)
Add a form to the document. |
String |
addImage(Image image)
Add an image to the document. |
String |
addImage(Image image,
double winch,
double hinch)
This is same as addImage() exception an explicit size of the painter area is specified. |
String |
addImage(URL image)
Add an image to the document. |
void |
addImageButton(String form,
String name,
String resource)
Add a form image button to the report. |
void |
addImageButton(String form,
String name,
String script,
String resource)
Add a form image button to the report. |
void |
addListElement(String form,
String name,
String[] selected,
String[] choices)
Add a list field to the report. |
void |
addListElement(String form,
String name,
String script,
String[] selected,
String[] choices)
Add a list field to the report. |
String |
addNewline(int n)
Add one or more newline to the document. |
String |
addPageBreak()
Add a page break to the document. |
String |
addPainter(Painter area)
Add a painter element to the document. |
String |
addPainter(Painter area,
double winch,
double hinch)
This is same as addPainter() except an explicit size of the painter area is specified. |
void |
addRadioButton(String form,
String name,
String text,
boolean selected,
String group)
Add a radio button to the report. |
void |
addRadioButton(String form,
String name,
String script,
String text,
boolean selected,
String group)
Add a radio button to the report. |
String |
addSeparator(int style)
Add a separator. |
String |
addSpace(int pixels)
Add horizontal space to the document. |
String |
addTab(int fill)
Add a tab. |
String |
addTable(TableLens table)
Add a table to the document. |
String |
addText(String text)
Add a text element to the document. |
String |
addText(TextLens text)
Add a text element to the document. |
void |
addTextArea(String form,
String name,
String text,
int rows,
int cols)
Add a textarea to a report. |
void |
addTextArea(String form,
String name,
String script,
String text,
int rows,
int cols)
Add a textarea to a report. |
String |
addTextBox(String text,
int border,
double winch,
double hinch,
int textalign)
Add a text box to the document. |
String |
addTextBox(TextLens text)
Add a text box to the document. |
String |
addTextBox(TextLens text,
int border,
double winch,
double hinch,
int textalign)
Add a text box to the document. |
void |
addTextField(String form,
String name,
String text,
int cols)
Add a textfield to a report. |
void |
addTextField(String form,
String name,
String script,
String text,
int cols)
Add a textfield to a report. |
String |
addTOC(TOC toc)
Add a table of contents section to the report. |
ReportElement |
getElement(int idx)
Get the specified element. |
ReportElement |
getElement(String id)
Get an element by element ID. |
int |
getElementCount()
Return the number of elements in the document. |
Object |
nextElement(Context context)
Get the next element in the composite lens. |
void |
removeAllElements()
Remove all elements. |
void |
removeElement(int idx)
Remove the specified element. |
void |
reset()
Reset the enumerator to the start. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected ReportSheet parent
| Constructor Detail |
|---|
public ElementContainer(ReportSheet parent)
| Method Detail |
|---|
public String addText(String text)
text - text string.
public String addText(TextLens text)
The inetsoft.report.lens package also contains a StreamTextLens, which allows retrieving text from a file, URL, or any input stream.
text - text content lens.
public String addTextBox(TextLens text)
text - text content.
public String addTextBox(TextLens text,
int border,
double winch,
double hinch,
int textalign)
text - text content.border - border line style. One of the line styles defined in
the StyleConstants class.winch - area width in inches. Pass 0 to use default.hinch - area height in inches. Pass 0 to use default.textalign - text alignment within the box.
public String addTextBox(String text,
int border,
double winch,
double hinch,
int textalign)
text - text content.border - border line style. One of the line styles defined in
the StyleConstants class.winch - area width in inches. Pass 0 to use default.hinch - area height in inches. Pass 0 to use default.textalign - text alignment within the box.
public String addPainter(Painter area)
area - the painter element.
public String addPainter(Painter area,
double winch,
double hinch)
area - the painter element.winch - area width in inches.hinch - area height in inches.
public String addChart(DataSet chart)
chart - chart data model.
public String addChart(DataSet chart,
double winch,
double hinch)
chart - the chart data set.winch - area width in inches.hinch - area height in inches.
public String addComponent(Component comp)
comp - component.
public String addComponent(Component component,
double winch,
double hinch)
component - component to paint.winch - area width in inches.hinch - area height in inches.
public String addImage(Image image)
image - image object.
public String addImage(Image image,
double winch,
double hinch)
image - image to paint.winch - area width in inches.hinch - area height in inches.
public String addImage(URL image)
image - image URL.
public String addBullet()
public String addBullet(Image icon)
icon - icon to used for bullet.
public String addSpace(int pixels)
pixels - space in pixels.
public String addNewline(int n)
n - number of newline.
public String addBreak()
public String addPageBreak()
public String addAreaBreak()
public String addConditionalPageBreak(int min)
min - minimu space in pixels.
public String addConditionalPageBreak(double inch)
inch - minimu space in inches.
public String addSeparator(int style)
style - the line style (defined in StyleConstants).
public String addTab(int fill)
fill - a line style defined in StyleConstants.
public String addTable(TableLens table)
table - table lens.
public String addForm(FormLens form)
form - form lens.
public String addTOC(TOC toc)
toc - table of contents style.
public String addBean(String name)
name - bean name, must be an existing bean in the bean library.
public void addButton(String form,
String name,
String text)
form - form name.name - field name.text - button text.
public void addButton(String form,
String name,
String script,
String text)
form - form name.name - field name.script - onSubmit java script.text - button text.
public void addImageButton(String form,
String name,
String resource)
form - form name.name - field name.resource - image resource name.
public void addImageButton(String form,
String name,
String script,
String resource)
form - form name.name - field name.script - onSubmit java script.resource - image resource name.
public void addCheckBox(String form,
String name,
String text,
boolean selected)
form - form name.name - field name.text - checkbox label.selected - true if the default is selected.
public void addCheckBox(String form,
String name,
String script,
String text,
boolean selected)
form - form name.name - field name.script - onSubmit java script.text - checkbox label.selected - true if the default is selected.
public void addRadioButton(String form,
String name,
String text,
boolean selected,
String group)
form - form name.name - field name.text - button label.selected - true if the default is selected.group - radio button group name.
public void addRadioButton(String form,
String name,
String script,
String text,
boolean selected,
String group)
form - form name.name - field name.script - onSubmit java script.text - button label.selected - true if the default is selected.group - radio button group name.
public void addChoiceElement(String form,
String name,
String selected,
String[] choices)
form - form name.name - field name.selected - the default selected item.choices - the list of choices.
public void addChoiceElement(String form,
String name,
String script,
String selected,
String[] choices)
form - form name.name - field name.script - onSubmit java script.selected - the default selected item.choices - the list of choices.
public void addListElement(String form,
String name,
String[] selected,
String[] choices)
form - form name.name - field name.selected - the default selected item.choices - the list of choices.
public void addListElement(String form,
String name,
String script,
String[] selected,
String[] choices)
form - form name.name - field name.script - onSubmit java script.selected - the default selected item.choices - the list of choices.
public void addDateCombo(String form,
String name,
Date date)
form - form name.name - field name.date - default date.
public void addDateCombo(String form,
String name,
String script,
Date date)
form - form name.name - field name.script - onSubmit java script.date - default date.
public void addTextField(String form,
String name,
String text,
int cols)
form - form name.name - field name.text - default text.cols - number of columns.
public void addTextField(String form,
String name,
String script,
String text,
int cols)
form - form name.name - field name.script - onSubmit java script.text - default text.cols - number of columns.
public void addTextArea(String form,
String name,
String text,
int rows,
int cols)
form - form name.name - field name.text - default text.rows - number of rows.cols - number of columns.
public void addTextArea(String form,
String name,
String script,
String text,
int rows,
int cols)
form - form name.name - field name.script - onSubmit java script.text - default text.rows - number of rows.cols - number of columns.public String addElement(ReportElement e)
e - document element.
public int getElementCount()
public ReportElement getElement(int idx)
idx - element index.
public void removeElement(int idx)
idx - element index.public ReportElement getElement(String id)
public void removeAllElements()
public Object nextElement(Context context)
CompositeLens
The context object can be modified to reflect the layout attributes of the element. The input value for the context is the current current at the point of printing this composite lens.
This method can be implemented to return the elements in the container. Each element must be one of the constants or classes defined in this class.
nextElement in interface CompositeLenspublic void reset()
CompositeLens
reset in interface CompositeLens
|
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 | ||||||||