quadbase.common.param

Class ReportParameterPage

java.lang.Object

quadbase.common.param.ParameterPage

quadbase.common.param.ReportParameterPage

public class ReportParameterPage
extends ParameterPage

A page that user specifies paramters for a parameterized report Typically, the use of a ParameterPage involves a ParameterPageWriter and the code is as follows:

 
     ParameterPage paramPage = QbReport.getParameterPage();
     Writer writer = new PrintWriter(out);
     HtmlParameterPageWriter paramPageWriter = 
          new HtmlParameterPageWriter(paramPage, writer);
     paramPageWriter.writePage();
     writer.flush();
     writer.close();
 
 

See Also:

ParameterPageWriter

Field Summary

Fields inherited from class quadbase.common.param.ParameterPage

ALIGNMENT_CENTER, ALIGNMENT_LEFT, ALIGNMENT_RIGHT, params, TABLE_LAYOUT_HORIZONTAL, TABLE_LAYOUT_VERTICAL

Constructor Summary

Constructors

Constructor and Description
ReportParameterPage(java.lang.String servletName, java.lang.String[] paramPageExportFormats, java.lang.String reportLoc, int format, boolean paramPageResetEnabled, int paramPageLayout, java.lang.String extraFormContent, java.lang.String securityLevel, java.lang.String serverName, int servletRunnerPort, java.lang.String servletDirectory, Parameters params, int order) Allocates a new ParameterPage that represents a parameter page object.
ReportParameterPage(java.lang.String servletName, java.lang.String[] paramPageExportFormats, java.lang.String reportLoc, int format, boolean paramPageResetEnabled, int paramPageLayout, java.lang.String extraFormContent, java.lang.String securityLevel, java.lang.String serverName, int servletRunnerPort, java.lang.String servletDirectory, Parameters params, int order, quadbase.common.util.IQueryFileInfo dbInfo)

Method Summary

Modifier and Type	Method and Description
int	getOrder()
java.lang.String	getSecurityLevel() Gets the name of the security level being applied to the parameter page
java.lang.String	getServerName() Gets the name of the server this parameter page will be served at
java.lang.String	getServletDirectory() Gets the url relative or absolute path to the servlet classes
int	getServletRunnerPort() Gets the servlet container's listening port number
void	setOrder(int order)

Methods inherited from class quadbase.common.param.ParameterPage

getAlignment, getBackgroundColor, getBackgroundColorHex, getBackgroundImage, getDateParameterCalendar, getDateParameterCalendarDatepicker, getDateParameterSelection, getDateVariable, getDateVariableDatepicker, getDbInfo, getDocumentTitle, getExtraFormContent, getFooter, getFormat, getHeader, getOnSubmit, getParameters, getParamFormName, getParamPageExportFormats, getResetDisplayName, getResetEnabled, getServletName, getSubmitDisplayName, getTableBackgroundColor, getTableBackgroundColorHex, getTableBorderColor, getTableBorderColorHex, getTableBorderThickness, getTableLayout, getTableOuterBorderOnly, getTargetLoc, getTextColor, getTextColorHex, getTextFont, getTextSize, getTextStyle, getTitleText, getTitleTextColor, getTitleTextColorHex, getTitleTextFont, getTitleTextSize, getTitleTextStyle, setAlignment, setBackgroundColor, setBackgroundColor, setBackgroundImage, setDateParameterCalendar, setDateParameterSelection, setDateVariable, setDocumentTitle, setFooter, setHeader, setJavaScriptLibPath, setOnSubmit, setParamFormName, setResetDisplayName, setResetEnabled, setSubmitDisplayName, setTableBackgroundColor, setTableBackgroundColor, setTableBorderColor, setTableBorderColor, setTableBorderThickness, setTableLayout, setTableOuterBorderOnly, setTextColor, setTextColor, setTextFont, setTextSize, setTextStyle, setTitleText, setTitleTextColor, setTitleTextColor, setTitleTextFont, setTitleTextSize, setTitleTextStyle, toCssHtmlString, toHtmlString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportParameterPage

public ReportParameterPage(java.lang.String servletName,
                           java.lang.String[] paramPageExportFormats,
                           java.lang.String reportLoc,
                           int format,
                           boolean paramPageResetEnabled,
                           int paramPageLayout,
                           java.lang.String extraFormContent,
                           java.lang.String securityLevel,
                           java.lang.String serverName,
                           int servletRunnerPort,
                           java.lang.String servletDirectory,
                           Parameters params,
                           int order)

Allocates a new ParameterPage that represents a parameter page object. This constructor is called internally. Use QbReport.getParameterPage() to get an instance of a ParameterPage.

Parameters:

subreportParams - each element is a Vector of Parameter objects

ReportParameterPage

public ReportParameterPage(java.lang.String servletName,
                           java.lang.String[] paramPageExportFormats,
                           java.lang.String reportLoc,
                           int format,
                           boolean paramPageResetEnabled,
                           int paramPageLayout,
                           java.lang.String extraFormContent,
                           java.lang.String securityLevel,
                           java.lang.String serverName,
                           int servletRunnerPort,
                           java.lang.String servletDirectory,
                           Parameters params,
                           int order,
                           quadbase.common.util.IQueryFileInfo dbInfo)

Method Detail

getSecurityLevel

public java.lang.String getSecurityLevel()

Gets the name of the security level being applied to the parameter page

getServerName

public java.lang.String getServerName()

Gets the name of the server this parameter page will be served at

getServletRunnerPort

public int getServletRunnerPort()

Gets the servlet container's listening port number

getServletDirectory

public java.lang.String getServletDirectory()

Gets the url relative or absolute path to the servlet classes

getOrder

public int getOrder()

setOrder

public void setOrder(int order)