ParameterPageWriter (EspressReport 6.6 Java API

java.lang.Object
- java.io.Writer
- - java.io.PrintWriter
  - - quadbase.common.param.ParameterPageWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

Direct Known Subclasses:

HtmlParameterPageWriter
```
public abstract class ParameterPageWriter
extends java.io.PrintWriter
```
An Abstract Writer that writes ParameterPage

See Also:

ParameterPage

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`alignment` Alignment (LEFT \| CENTER \| RIGHT)
`protected java.lang.String`	`backgroundColor` background color in hex
`protected java.lang.String`	`backgroundImage` background image
`protected boolean`	`dateParameterCalendar` whether dates parameter have month/day/year calendar
`protected java.lang.String`	`dateParameterCalendarDatepicker` the path to the datepicker folder that contains the javascript and images
`protected boolean`	`dateParameterSelection` whether dates parameter have month/day/year selection list
`protected boolean`	`dateVariable` whether dates parameter is specified with a date variable
`protected java.lang.String`	`dateVariableDatepicker` the path to the datepicker folder that contains the javascript and images
`protected quadbase.common.util.IQueryFileInfo`	`dbInfo` database connection information
`protected java.lang.String`	`docTitle` Document title
`protected java.lang.String`	`extraFormContent` Extra form contents
`protected java.lang.String`	`footer` the footer text
`protected int`	`format` the export format
`protected java.lang.String`	`header` the header text
`protected ParameterPage`	`page` The ParameterPage to write
`protected java.lang.String[]`	`paramDateFormat` an array of default parameter date format
`protected java.lang.String[]`	`paramNameArr` an array of parameter names
`protected java.lang.String[]`	`paramPageExportFormats` an array of export formats that the ParameterPage can be exported.
`protected int`	`paramPageLayout` Layout (HORIZONTAL \| VERTICAL)
`protected boolean`	`paramPageResetEnabled` State of the Reset button
`protected java.lang.String[]`	`paramValueArr` an array of default parameter values
`protected java.lang.String`	`securityLevel` the security level associated with the report
`protected java.lang.String`	`tableBackgroundColor` background color of the table
`protected java.lang.String`	`tableBorderColor` table border color in hex
`protected int`	`tableBorderThickness` table border thickness in pixels
`protected boolean`	`tableOuterBorderOnly` the state of the visiblity of the table outer border
`protected java.lang.String`	`targetLoc` the location of the report or chart
`protected java.lang.String`	`textColor` text color in hex
`protected java.lang.String`	`textFont` text font
`protected int`	`textSize` text size
`protected int`	`textStyle` text style
`protected java.lang.String`	`titleText` table title text
`protected java.lang.String`	`titleTextColor` table title text color in hex
`protected java.lang.String`	`titleTextFont` table title text font
`protected int`	`titleTextSize` table title text size
`protected int`	`titleTextStyle` table title text style

Fields inherited from class java.io.PrintWriter
out

Fields inherited from class java.io.Writer
lock

Constructor Summary

Constructors
Constructor and Description

ParameterPageWriter(ParameterPage page, java.io.Writer out)
Allocates a writer that writes ParameterPage

Constructors
Constructor and Description
`ParameterPageWriter(ParameterPage page, java.io.Writer out)` Allocates a writer that writes ParameterPage

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`refresh()` Refreshes the parameter table content.
`abstract void`	`writePage()` writes the entire parameter page to the output writer

Methods inherited from class java.io.PrintWriter
append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - page
```
protected ParameterPage page
```
    The ParameterPage to write
  - paramPageExportFormats
```
protected java.lang.String[] paramPageExportFormats
```
    an array of export formats that the ParameterPage can be exported. For ERES only
  - securityLevel
```
protected java.lang.String securityLevel
```
    the security level associated with the report
  - targetLoc
```
protected java.lang.String targetLoc
```
    the location of the report or chart
  - format
```
protected int format
```
    the export format
  - extraFormContent
```
protected java.lang.String extraFormContent
```
    Extra form contents
  - paramNameArr
```
protected java.lang.String[] paramNameArr
```
    an array of parameter names
  - paramValueArr
```
protected java.lang.String[] paramValueArr
```
    an array of default parameter values
  - paramDateFormat
```
protected java.lang.String[] paramDateFormat
```
    an array of default parameter date format
  - dbInfo
```
protected quadbase.common.util.IQueryFileInfo dbInfo
```
    database connection information
  - paramPageResetEnabled
```
protected boolean paramPageResetEnabled
```
    State of the Reset button
  - paramPageLayout
```
protected int paramPageLayout
```
    Layout (HORIZONTAL | VERTICAL)
  - alignment
```
protected int alignment
```
    Alignment (LEFT | CENTER | RIGHT)
  - header
```
protected java.lang.String header
```
    the header text
  - footer
```
protected java.lang.String footer
```
    the footer text
  - tableOuterBorderOnly
```
protected boolean tableOuterBorderOnly
```
    the state of the visiblity of the table outer border
  - tableBackgroundColor
```
protected java.lang.String tableBackgroundColor
```
    background color of the table
  - tableBorderColor
```
protected java.lang.String tableBorderColor
```
    table border color in hex
  - tableBorderThickness
```
protected int tableBorderThickness
```
    table border thickness in pixels
  - textColor
```
protected java.lang.String textColor
```
    text color in hex
  - textFont
```
protected java.lang.String textFont
```
    text font
  - textSize
```
protected int textSize
```
    text size
  - textStyle
```
protected int textStyle
```
    text style
  - titleText
```
protected java.lang.String titleText
```
    table title text
  - titleTextColor
```
protected java.lang.String titleTextColor
```
    table title text color in hex
  - titleTextFont
```
protected java.lang.String titleTextFont
```
    table title text font
  - titleTextSize
```
protected int titleTextSize
```
    table title text size
  - titleTextStyle
```
protected int titleTextStyle
```
    table title text style
  - docTitle
```
protected java.lang.String docTitle
```
    Document title
  - backgroundImage
```
protected java.lang.String backgroundImage
```
    background image
  - backgroundColor
```
protected java.lang.String backgroundColor
```
    background color in hex
  - dateParameterSelection
```
protected boolean dateParameterSelection
```
    whether dates parameter have month/day/year selection list
  - dateParameterCalendar
```
protected boolean dateParameterCalendar
```
    whether dates parameter have month/day/year calendar
  - dateParameterCalendarDatepicker
```
protected java.lang.String dateParameterCalendarDatepicker
```
    the path to the datepicker folder that contains the javascript and images
  - dateVariable
```
protected boolean dateVariable
```
    whether dates parameter is specified with a date variable
  - dateVariableDatepicker
```
protected java.lang.String dateVariableDatepicker
```
    the path to the datepicker folder that contains the javascript and images
- Constructor Detail
  - ParameterPageWriter
```
public ParameterPageWriter(ParameterPage page,
                           java.io.Writer out)
```
    Allocates a writer that writes ParameterPage
    
    Parameters:
    
    page - the ParameterPage to write
    
    out - the output writer
- Method Detail
  - writePage
```
public abstract void writePage()
                        throws java.io.IOException
```
    writes the entire parameter page to the output writer
    
    Throws:
    
    java.io.IOException
  - refresh
```
public void refresh()
```
    Refreshes the parameter table content. Call this only when the parameter information in the data source has changed. For example, if more distinct values of a particular parameter are added to the data source. Called internally when the object is first created

Class ParameterPageWriter

Field Summary

Fields inherited from class java.io.PrintWriter

Fields inherited from class java.io.Writer

Constructor Summary

Method Summary

Methods inherited from class java.io.PrintWriter

Methods inherited from class java.lang.Object

Field Detail

page

paramPageExportFormats

securityLevel

targetLoc

format

extraFormContent

paramNameArr

paramValueArr

paramDateFormat

dbInfo

paramPageResetEnabled

paramPageLayout

alignment

header

footer

tableOuterBorderOnly

tableBackgroundColor

tableBorderColor

tableBorderThickness

textColor

textFont

textSize

textStyle

titleText

titleTextColor

titleTextFont

titleTextSize

titleTextStyle

docTitle

backgroundImage

backgroundColor

dateParameterSelection

dateParameterCalendar

dateParameterCalendarDatepicker

dateVariable

dateVariableDatepicker

Constructor Detail

ParameterPageWriter

Method Detail

writePage

refresh