EspressReport 6.6

quadbase.common.param
Class CssHtmlParameterPageWriter

java.lang.Object
  extended by java.io.Writer
      extended by java.io.PrintWriter
          extended by quadbase.common.param.ParameterPageWriter
              extended by quadbase.common.param.HtmlParameterPageWriter
                  extended by quadbase.common.param.CssHtmlParameterPageWriter
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class CssHtmlParameterPageWriter
extends HtmlParameterPageWriter

Writer that writes ParameterPage in HTML format with Cascading Style Sheet Objects and Styles embedded. In all cases, an external css style sheet has to be present and will be used for setting the styles of the parameter page. To set the path to the external css style sheet to use, use the method setCssFile(String cssFile).

The styles of each sub-component of a parameter page can be defined using CSS styles. Each sub-component is referenced by a CSS class name as described below

 The following is an outline for the parameter page generated including CSS class names:
 
 <head>                    // generated through the writeHead() method
      <link>               // points to the location of the style sheet
 </head>
 <body>                    // generated through the writeBody() method
      <div class="paramTableTitle">
                           // generated through the writeTableTitle() method
      </div>
      <form>               // generated through the writeBodyBody() method in the superclass
           <table class="paramTable">
           
                <td class="paramTableCategory">
                           // display parameter titles, 
                </td>
                
                <td class="paramTableValues">
                     <div class="paramValue_X">
                          <select class="paramValue">
                           // display parameter values or inputbox, 
                           // X represents the index of the parameter
                          </select>
                     </div>
                </td>     
                
           // ... Repeat for each parameter
           </table>
           
           <input class="submitButton">
                           // button to submit the form
           <input class="resetButton">
                           // button to reset the form
      </form>
 </body>
 
 

See Also:
HtmlParameterPageWriter

Field Summary
 
Fields inherited from class quadbase.common.param.HtmlParameterPageWriter
DEFAULT_DATE_FORMAT, DEFAULT_TIMESTAMP_FORMAT, serverName, servletDirectory, servletName, servletRunnerPort
 
Fields inherited from class quadbase.common.param.ParameterPageWriter
alignment, backgroundColor, backgroundImage, dateParameterCalendar, dateParameterCalendarDatepicker, dateParameterSelection, dateVariable, dateVariableDatepicker, dbInfo, docTitle, extraFormContent, footer, format, header, page, paramDateFormat, paramNameArr, paramPageExportFormats, paramPageLayout, paramPageResetEnabled, paramValueArr, securityLevel, tableBackgroundColor, tableBorderColor, tableBorderThickness, tableOuterBorderOnly, targetLoc, textColor, textFont, textSize, textStyle, titleText, titleTextColor, titleTextFont, titleTextSize, titleTextStyle
 
Fields inherited from class java.io.PrintWriter
out
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
CssHtmlParameterPageWriter(ParameterPage page, java.io.Writer out)
          Allocates a CssHtmlParameterPageWriter
CssHtmlParameterPageWriter(ParameterPage page, java.io.Writer out, boolean isEspressMobile)
           
 
Method Summary
 java.lang.String getCssFile()
          Gets the path to the css file in use.
 void setCssFile(java.lang.String cssFile)
          Sets the path to the css file to use.
 void writeBody()
          Writes the content between the <body> and </body> tags (writes tags as well) of the html parameter page and centers it on the page.
protected  void writeBodyFooter()
          Writes the conclusion/footer component (the String footer that is set using ParameterPage.setFooter()) of the contents inside the <body> and </body> tags of the HTML parameter page.
protected  void writeBodyHeader()
          Writes the preface/header component (the String header that is set using ParameterPage.setHeader()) of the contents inside the <body> and </body> tags of the HTML parameter page.
protected  void writeFormButtons()
          Writes the form buttons (submit and reset).
 void writeHead()
          Writes only the content between the <head> and </head> tags of the parameter page.
protected  void writeParamTableCategory(java.lang.String paramName, java.lang.String tdAttributes)
          Writes a parameter table category component inside the parameter table enclosed in <TD> and </TD> tags.
protected  void writeParamTableOpenTag()
          Writes the <TABLE> tag for the parameter table.
protected  void writeParamTableValue(java.lang.String name, java.lang.String value, java.lang.String tdAttributes)
          Writes a parameter table value component inside the parameter table enclosed in <TD> and </TD> tags.
protected  void writeParamTableValues(java.lang.String name, java.lang.String selectAttributes, java.util.Vector values, java.lang.String paramValue, java.lang.String tdAttributes)
          Writes a parameter table values component inside the parameter table enclosed in <TD> and </TD> tags.
protected  void writeParamValue(java.lang.String name, java.lang.String value)
          Writes a parameter value component.
protected  void writeParamValueDate(java.lang.String name, java.lang.String value, Param param)
          Writes the parameter value component.
protected  void writeParamValues(java.lang.String name, java.lang.String attributes, java.util.Vector values, java.lang.String paramValue)
          Writes a parameter values component.
protected  void writeResetButton()
          Writes the reset button.
protected  void writeSubmitButton()
          Writes the submit button.
 void writeTableTitle()
          Writes the title of the parameter table
 
Methods inherited from class quadbase.common.param.HtmlParameterPageWriter
getHiddenParameters, getHtmlWriter, getParamDisplayNames, getServletName, printCalendarJavascript, printDateVariableJavascript, setHiddenParameters, setHiddenParameterValues, setJavaScriptLibPath, setParamDisplayNames, writeBodyBody, writeHeadJavascript, writeHiddenParamValue, writePage, writePageExportFormats, writeParamName, writeParamTable, writeParamTable, writeParamTableCloseTag, writeParamTableMain, writeParamTableValue, writeParamValue, writeParamValuesOptions, writeParamValuesOptionsYUI
 
Methods inherited from class quadbase.common.param.ParameterPageWriter
refresh
 
Methods inherited from class java.io.PrintWriter
append, append, append, checkError, 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
 

Constructor Detail

CssHtmlParameterPageWriter

public CssHtmlParameterPageWriter(ParameterPage page,
                                  java.io.Writer out)
Allocates a CssHtmlParameterPageWriter

Parameters:
page - the ParameterPage to write
out - the output to write to

CssHtmlParameterPageWriter

public CssHtmlParameterPageWriter(ParameterPage page,
                                  java.io.Writer out,
                                  boolean isEspressMobile)
Method Detail

setCssFile

public void setCssFile(java.lang.String cssFile)
Sets the path to the css file to use. Can be relative or absolute. This method must be called to set the correct external css file to use for this page. There is no internal style defined for any CSS classes

Parameters:
cssFile - the path to the external css style sheet

getCssFile

public java.lang.String getCssFile()
Gets the path to the css file in use. Can be relative or absolute.


writeHead

public void writeHead()
Writes only the content between the <head> and </head> tags of the parameter page. This will include the link tag which points to the css file.

Overrides:
writeHead in class HtmlParameterPageWriter

writeBody

public void writeBody()
Writes the content between the <body> and </body> tags (writes tags as well) of the html parameter page and centers it on the page. This includes the table title, form, parameter table and form buttons

CSS Tags used include:
<table class="paramTable">
<td class="paramTableCategory">
<td class="paramTableValues">
<div class="paramValue_X"> // X represents the index of the parameter
<select class="paramValue_X_input"> // X represents the index of the parameter
<input class="submitButton">
<input class="resetButton">

Overrides:
writeBody in class HtmlParameterPageWriter

writeTableTitle

public void writeTableTitle()
Writes the title of the parameter table

Overrides:
writeTableTitle in class HtmlParameterPageWriter

writeBodyHeader

protected void writeBodyHeader()
Description copied from class: HtmlParameterPageWriter
Writes the preface/header component (the String header that is set using ParameterPage.setHeader()) of the contents inside the <body> and </body> tags of the HTML parameter page.

Overrides:
writeBodyHeader in class HtmlParameterPageWriter

writeBodyFooter

protected void writeBodyFooter()
Description copied from class: HtmlParameterPageWriter
Writes the conclusion/footer component (the String footer that is set using ParameterPage.setFooter()) of the contents inside the <body> and </body> tags of the HTML parameter page.

Overrides:
writeBodyFooter in class HtmlParameterPageWriter

writeParamTableOpenTag

protected void writeParamTableOpenTag()
Description copied from class: HtmlParameterPageWriter
Writes the <TABLE> tag for the parameter table.

Overrides:
writeParamTableOpenTag in class HtmlParameterPageWriter

writeParamTableCategory

protected void writeParamTableCategory(java.lang.String paramName,
                                       java.lang.String tdAttributes)
Description copied from class: HtmlParameterPageWriter
Writes a parameter table category component inside the parameter table enclosed in <TD> and </TD> tags. A parameter table category is a generalized component for all parameter names.

Overrides:
writeParamTableCategory in class HtmlParameterPageWriter
Parameters:
paramName - the name of the parameter
tdAttributes - the attributes for the <TD> tag

writeParamTableValues

protected void writeParamTableValues(java.lang.String name,
                                     java.lang.String selectAttributes,
                                     java.util.Vector values,
                                     java.lang.String paramValue,
                                     java.lang.String tdAttributes)
Description copied from class: HtmlParameterPageWriter
Writes a parameter table values component inside the parameter table enclosed in <TD> and </TD> tags. A parameter table values component is a generalized component for all parameter values components.

Overrides:
writeParamTableValues in class HtmlParameterPageWriter
Parameters:
name - the name of the INPUT element
selectAttributes - the attributes for the selection list
values - the list of possible values that the parameter can take
paramValue - the selected parameter value
tdAttributes - the attributes for the <TD> tag

writeParamTableValue

protected void writeParamTableValue(java.lang.String name,
                                    java.lang.String value,
                                    java.lang.String tdAttributes)
Description copied from class: HtmlParameterPageWriter
Writes a parameter table value component inside the parameter table enclosed in <TD> and </TD> tags. A parameter table value component is a generalized component for all parameter value components.

Overrides:
writeParamTableValue in class HtmlParameterPageWriter
Parameters:
name - the name of the INPUT element
value - the default value of the text box
tdAttributes - the attributes for the <TD> tag

writeParamValue

protected void writeParamValue(java.lang.String name,
                               java.lang.String value)
Description copied from class: HtmlParameterPageWriter
Writes a parameter value component. A parameter value component is an input text box for inputting a parameter value for a parameter.

Overrides:
writeParamValue in class HtmlParameterPageWriter
Parameters:
name - the name of the INPUT element
value - the default value of the text box

writeParamValueDate

protected void writeParamValueDate(java.lang.String name,
                                   java.lang.String value,
                                   Param param)
Description copied from class: HtmlParameterPageWriter
Writes the parameter value component. If it is a date and date parameter selection is OFF and date parameter calendar is ON, prints the calendar javascript image and function call.

Overrides:
writeParamValueDate in class HtmlParameterPageWriter
Parameters:
name - the name of the INPUT element
value - the default value of the text box
param - the parameter that holds information about custom date format if applicable.

writeParamValues

protected void writeParamValues(java.lang.String name,
                                java.lang.String attributes,
                                java.util.Vector values,
                                java.lang.String paramValue)
Description copied from class: HtmlParameterPageWriter
Writes a parameter values component. A parameter values component is a select list for choosing the parameter value for a parameter.

Overrides:
writeParamValues in class HtmlParameterPageWriter
Parameters:
name - the name of the SELECT element
attributes - the String of attributes to be included in the SELECT element (ex. <SELECT attributes></SELECT>
values - a vector of values to be included in the options of the select list
paramValue - the value to be selected, if it exists in the VALUES argument

writeFormButtons

protected void writeFormButtons()
Description copied from class: HtmlParameterPageWriter
Writes the form buttons (submit and reset).

Overrides:
writeFormButtons in class HtmlParameterPageWriter

writeSubmitButton

protected void writeSubmitButton()
Description copied from class: HtmlParameterPageWriter
Writes the submit button.

Overrides:
writeSubmitButton in class HtmlParameterPageWriter

writeResetButton

protected void writeResetButton()
Description copied from class: HtmlParameterPageWriter
Writes the reset button.

Overrides:
writeResetButton in class HtmlParameterPageWriter

EspressReport 6.6