|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.asset.AbstractAssetEngine
inetsoft.report.internal.StyleCore
inetsoft.report.ReportSheet
inetsoft.report.StyleSheet
public class StyleSheet
StyleSheet is one of the two report types in Style Report. It uses a flow layout model. Report contents are laid out in one flow. The flow can be across pages, or through page areas defined by page layout. Its conceptual model is very close to regular word processors.
ReportSheet contains the common API for report generation. Please refer to the Style Report Programming Guide for more details on the concepts and features of the StyleSheet.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class inetsoft.report.internal.StyleCore |
|---|
inetsoft.report.internal.StyleCore.ActionScriptable |
| Nested classes/interfaces inherited from class inetsoft.uql.asset.AbstractAssetEngine |
|---|
AbstractAssetEngine.ReportSheetDependencyFinder, AbstractAssetEngine.SheetTransformListener, AbstractAssetEngine.StorageChangeListener |
| Field Summary | |
|---|---|
protected Hashtable |
areamap
|
protected Vector |
elements
|
protected boolean |
newPage
|
| Fields inherited from class inetsoft.report.ReportSheet |
|---|
BODY, DEFAULT_FOOTER, DEFAULT_HEADER, DOWN, EVEN_PAGE_FOOTER, EVEN_PAGE_HEADER, FIRST_PAGE_FOOTER, FIRST_PAGE_HEADER, ODD_PAGE_FOOTER, ODD_PAGE_HEADER, PAINTER_BREAKABLE, PAINTER_NON_BREAK, TABLE_EQUAL_WIDTH, TABLE_FIT_CONTENT, TABLE_FIT_CONTENT_1PP, TABLE_FIT_CONTENT_PAGE, TABLE_FIT_PAGE, UP, WRAP_BOTH, WRAP_LEFT, WRAP_NONE, WRAP_RIGHT, WRAP_TOP_BOTTOM |
| Fields inherited from class inetsoft.report.internal.StyleCore |
|---|
advanceLine, alignment, anchor, autosize, background, bg, bgimage, bglayout, bgsize, burstInfo, chartinfo, cmargin, COMPLETED, contexts, current, currFooter, currFrame, currHeader, DESIGN_MODE, elemFooter, elemHeader, evenFooter, evenHeader, firstFooter, firstHeader, font, footerElements, footerFromEdge, foreground, formatmap, frames, g_pmargin, header, headerElements, headerFromEdge, headingCnt, headingMap, hfFmt, hindent, horFlow, idmap, indent, initCalled, initCmd, initScript, justify, lastHead, lineH, LIVE_MODE, loadCmd, loadScript, locale, margin, MORE_ELEM, MORE_FLOW, nextOrient, npframes, nplayout, numHeadingMap, oddFooter, oddHeader, orphan, overrideFooter, overrideFooterContinue, overrideHeader, overrideHeaderContinue, padding, pageBox, pagebreakCmd, pagebreakScript, painterLayout, painterMargin, parameters, parentElem, pglayout, pgStart, pgTotal, pmargin, presentermap, printBox, printCmd, printHead, printMode, printScript, prop, psheet, queries, reportmode, rewinded, RUN_MODE, runningScript, runningTotals, scriptenv, secHeadingMap, secNumHeadingMap, sepadv, spacing, tableadv, tableorphan, tableW, tabStops, textadv, wrapping |
| Fields inherited from class inetsoft.uql.asset.AbstractAssetEngine |
|---|
admin, catalog, editing, istore, LOCAL, parent, scopes |
| Fields inherited from interface inetsoft.uql.XQueryRepository |
|---|
GLOBAL_SCOPE, LOCAL_QUERY, LOCAL_SCOPE, NORMAL_QUERY |
| Fields inherited from interface inetsoft.report.internal.ParameterSheetRepository |
|---|
EMBED_PARAMETER_SHEET, EMBED_SECTION |
| Fields inherited from interface inetsoft.uql.asset.AssetRepository |
|---|
ASSET_ERRORS, COMPONENT_SCOPE, GLOBAL_SCOPE, IGNORE_PERM, LOCAL_QUERY, QUERY_SCOPE, REPORT_SCOPE, REPORT_WORKSHEET, REPOSITORY_SCOPE, TEMPORARY_SCOPE, USER_SCOPE |
| Constructor Summary | |
|---|---|
StyleSheet()
Create an empty StyleSheet. |
|
| 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. |
String |
addButton(String form,
String name,
String text)
Add a form button to the report. |
String |
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. |
String |
addCheckBox(String form,
String name,
String text,
boolean selected)
Add a checkbox to the report. |
String |
addCheckBox(String form,
String name,
String script,
String text,
boolean selected)
Add a checkbox to the report. |
String |
addChoiceElement(String form,
String name,
String selected,
String[] choices)
Add a choice field to the report. |
String |
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 |
addComposite(CompositeLens container)
Add a composite element to the report. |
String |
addConditionalPageBreak(double inch)
Add a conditional page break. |
String |
addConditionalPageBreak(int min)
Add a conditional page break. |
String |
addDateCombo(String form,
String name,
Date date)
Add a date combobox to a report. |
String |
addDateCombo(String form,
String name,
String script,
Date date)
Add a date combobox 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. |
String |
addImageButton(String form,
String name,
String resource)
Add a form image button to the report. |
String |
addImageButton(String form,
String name,
String script,
String resource)
Add a form image button to the report. |
String |
addListElement(String form,
String name,
String[] selected,
String[] choices)
Add a list field to the report. |
String |
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 |
addObject(Object obj)
Add an object 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. |
String |
addRadioButton(String form,
String name,
String text,
boolean selected,
String group)
Add a radio button to the report. |
String |
addRadioButton(String form,
String name,
String script,
String text,
boolean selected,
String group)
Add a radio button to the report. |
String |
addRightTab()
Add a right aligned tab. |
String |
addSection(SectionLens section)
Add a section element to the report. |
String |
addSection(SectionLens section,
TableLens table)
Add a section element 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. |
String |
addTextArea(String form,
String name,
String text,
int rows,
int cols)
Add a textarea to a report. |
String |
addTextArea(String form,
String name,
String script,
String text,
int rows,
int cols)
Add a textarea to a report. |
String |
addTextBox(String text)
Add a text box to the document. |
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. |
String |
addTextField(String form,
String name,
String text,
int cols)
Add a textfield to a report. |
String |
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. |
Object |
clone()
Make a copy of this report. |
Object |
clone(boolean deep)
Make a copy of this report. |
protected void |
copyStyleSheet(StyleSheet that,
boolean flag)
Copy this report to that report. |
protected void |
copyStyleSheet(StyleSheet that,
boolean flag,
boolean deep)
Copy this report to that report. |
static StyleSheet |
createStyleSheet()
Deprecated. 4.1 |
Vector |
getAllElements()
Get all elements in the report, including body, and non-flow area elements. |
ReportElement |
getElement(int idx)
Get the specified element. |
int |
getElementCount()
Return the number of elements in the document. |
int |
getElementIndex(ReportElement e)
Get the index of the specified element. |
Enumeration |
getElementPageLayouts()
Get all page layout associated with elements. |
Enumeration |
getElementsWithPageLayout()
Get elements with element associated page areas. |
Integer |
getNextOrientation()
Get the page orientation for the next page. |
PageLayout |
getPageLayout(String id)
Get the page layout associated with an element. |
String |
insertElement(int idx,
ReportElement e)
Insert the element at specified position (before). |
void |
moveElement(String id,
int direction)
Move element up or down. |
boolean |
printNext(StylePage pg)
Print one page. |
boolean |
printNextPage(StylePage pg)
Print the next page. |
protected void |
removeContents()
Remove all elements from the contents. |
void |
removeElement(int idx)
Remove the specified element. |
void |
removeElement(String id)
Remove the specified element. |
void |
removePageLayout(String id)
Remove an element associated page layout. |
protected void |
replaceElement(int idx,
ReportElement e)
Replace the specified element. |
protected void |
replaceElement(String id,
ReportElement e)
Replace the specified element. |
void |
requestNewPage()
Request a new page. |
protected void |
resetContents()
Reset all elemnts in the contents. |
String |
setPageColumns(int cols)
Divide page in to number of columns. |
String |
setPageColumns(int cols,
ReportElement top)
Divide page in to number of columns. |
String |
setPageLayout(PageLayout layout)
Change the page layout. |
String |
setPageLayout(PageLayout layout,
ReportElement top)
Change the page layout. |
void |
setPageLayout(PageLayout layout,
String id)
Associate a page layout with an element. |
String |
toString()
|
| Methods inherited from class inetsoft.report.internal.StyleCore |
|---|
addChangeListener, addr, addScriptObject, advance, alignLine, append, append, calcGrid, checkDataSourceFolderPermission, checkDataSourcePermission, checkQueryFolderPermission, checkQueryPermission, cloneElements, cloneElements, complete, completeElement, copyQueries, copyStyleCore, createFinder, createFormatMap, createPresenterMap, deleteScriptEnv, fireEvent, format, format, getActionScriptable, getAllFooterElements, getAllHeaderElements, getBackgroundImageLocation, getBuildNumber, getBurstInfo, getCompositeElement, getDefaultFooter, getDefaultHeader, getDependencyFile, getDependencyFileName, getElementFooters, getElementHeaders, getElementWidth, getElemInfoBoundsMap, getElemInfoMap, getFinder, getFormat, getFormats, getFrames, getHeadingNumberArray, getHFTextFormatter, getLocalQueryRepository, getNextHeadingNumberArray, getNextID, getNumHeadingMap, getOnLoadResult, getOutputType, getPageTotalStart, getPagingLock, getParameterSheet, getParentScope, getPresenter, getProperties, getQueryManager, getReportManager, getReportMode, getScriptEnv, getScriptObject, getSecNumHeadingMap, getSheet, getTextSize, getTopReport, getVariableTable, hasOnPrint, isDesignTime, isLimited, isPrintMode, isReusePages, isRunTime, isSubreport, parseAssetRepository, printFixedContainer, printFixedContainer, processHF, processHF, putElemWarnings, removeChangeListener, renameQuery, renameQuery, resetCache, resetHeadingNumberArray, resetOnLoad, resetScriptEnv, restoreHeadingNumberArray, runOnInit, runOnLoad, runOnPrint, setBackgroundImageLocation, setBurstInfo, setDesignTime, setElemInfoBoundsMap, setFooterContinue, setHeaderContinue, setHeadingNumberArray, setHFTextFormatter, setHindent, setOverrideFooter, setOverrideHeader, setPageTotalStart, setParentScope, setPrintMode, setReportMode, setReportMode, setReusePages, setScriptEnv, setSubreport, setValue, setVariableTable, skip, toString, updateParameterSheet, writeAssetRepository |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected transient boolean newPage
protected Vector elements
protected Hashtable areamap
| Constructor Detail |
|---|
public StyleSheet()
| Method Detail |
|---|
public static StyleSheet createStyleSheet()
public String setPageLayout(PageLayout layout)
layout - page areas.
public String setPageLayout(PageLayout layout,
ReportElement top)
layout - page areas.top - the top element of this page. The page layout is
changed before this element, which forces a new page. If the
top element is null, the page layout is added to the end of
the report.
public void setPageLayout(PageLayout layout,
String id)
layout - page areas. If the value is null, the page areas
setting for the element is removed.id - element ID.public Enumeration getElementsWithPageLayout()
public Enumeration getElementPageLayouts()
public PageLayout getPageLayout(String id)
id - element ID.
public void removePageLayout(String id)
id - element ID.public String setPageColumns(int cols)
cols - number of columns.
public String setPageColumns(int cols,
ReportElement top)
cols - number of columns.top - the top element of this page. The page layout is
changed before this element, which forces a new page. If the
top element is null, the page layout is added to the end of
the report.
public String addObject(Object obj)
If there is no presenter registered at the document for this type of object, the StyleSheet then check if a Format is register for this class. If there is a Format, it's used to format the object into string and treated as a regular text.
If there is no format registered for this object type, the object is converted to a string (toString()) and treated as a regular text element.
obj - object value.
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(String 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 element.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)
throws IOException
image - image URL.
IOExceptionpublic 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 addRightTab()
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 String addComposite(CompositeLens container)
container - composite lens.
public String addSection(SectionLens section)
public String addSection(SectionLens section,
TableLens table)
public String addButton(String form,
String name,
String text)
form - form name.name - field name.text - button text.
public String addButton(String form,
String name,
String script,
String text)
form - form name.name - field name.script - onSubmit java script.text - button text.
public String addImageButton(String form,
String name,
String resource)
form - form name.name - field name.resource - image resource name.
public String addImageButton(String form,
String name,
String script,
String resource)
form - form name.name - field name.script - onSubmit java script.resource - image resource name.
public String 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 String 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 String 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 String 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 String 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 String 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 String 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 String 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 String addTextField(String form,
String name,
String text,
int cols)
form - form name.name - field name.text - default text.cols - number of columns.
public String 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 String addDateCombo(String form,
String name,
Date date)
form - form name.name - field name.date - default date.
public String addDateCombo(String form,
String name,
String script,
Date date)
form - form name.name - field name.script - onSubmit java script.date - default date.
public String 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 String 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 int getElementIndex(ReportElement e)
e - element.
public void removeElement(int idx)
idx - element index.public void removeElement(String id)
removeElement in class ReportSheetid - element id in string format.
protected void replaceElement(int idx,
ReportElement e)
idx - element id in string format.
protected void replaceElement(String id,
ReportElement e)
replaceElement in class ReportSheetid - element id in string format.
public void moveElement(String id,
int direction)
moveElement in class ReportSheetid - element id in string format.direction - move direction, up or down.
public String insertElement(int idx,
ReportElement e)
idx - position to insert.e - element.
public Vector getAllElements()
getAllElements in class inetsoft.report.internal.StyleCorepublic boolean printNext(StylePage pg)
A StylePage contains information on how to print a particular page. Its print() method can be used to perform the actual printing of the page contents to a printer graphics.
printNext in class ReportSheetpg - style page.public Integer getNextOrientation()
getNextOrientation in class ReportSheetpublic boolean printNextPage(StylePage pg)
printNextPage in class ReportSheetprotected void removeContents()
removeContents in class ReportSheetprotected void resetContents()
resetContents in class ReportSheetpublic String toString()
toString in class Objectpublic Object clone()
clone in class ReportSheetpublic Object clone(boolean deep)
clone in class ReportSheet
protected void copyStyleSheet(StyleSheet that,
boolean flag)
that - the report copied to.flag - if true flag all copied elements as from template.
protected void copyStyleSheet(StyleSheet that,
boolean flag,
boolean deep)
that - report the report copied to.flag - if true flag all copied elements as from template.public void requestNewPage()
|
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 | ||||||||