org.xmlactions.pager.actions.form

Class List

java.lang.Object

org.xmlactions.action.actions.BaseAction

org.xmlactions.pager.actions.form.BaseFormAction

org.xmlactions.pager.actions.form.CommonFormFields

org.xmlactions.pager.actions.form.drawing.DrawFormFields

org.xmlactions.pager.actions.form.List

All Implemented Interfaces:

FormDrawing, IStorageFormAction

public class List
extends DrawFormFields
implements FormDrawing, IStorageFormAction

Builds a html list display from a query.

parameters / attributes will build the the html attributes needed for display.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	List.format
static class	List.request_parameters It is possible to override the setting for the following list attributes by passing the values in the browser request parameters.

Field Summary

Fields inherited from class org.xmlactions.action.actions.BaseAction

CHILD, CONTENT

Constructor Summary

Constructors

Constructor and Description
List()

Method Summary

Modifier and Type	Method and Description
HtmlTh	buildHeader(CommonStorageField field, Theme theme, java.lang.String align)
HtmlTh	buildHeader(java.lang.String tooltip, java.lang.String presentationName, Theme theme, java.lang.String align)
HtmlDiv	drawDivValue(IDrawParams params, java.lang.String fieldPresentationData, Theme theme)
HtmlTd	drawRowValue(IDrawParams params, Html[] fieldPresentationData, Theme theme)
java.lang.String	execute(IExecContext execContext) Executes an action
IExecContext	getExecContext()
FieldList	getField_list()
PresentationFormAction	getForm()
java.lang.String	getGroup_by()
java.lang.String	getHeader_align()
java.util.List<HtmlInput>	getHiddenFields()
java.lang.String	getJoin()
java.lang.String	getKey()
java.lang.String	getOrder_by()
java.lang.String	getOutput_format()
int	getPage()
java.lang.String	getPresentation_form()
java.lang.String	getRow_height()
java.lang.String	getRow_map_name()
java.lang.String	getRows() Number of rows to return for a query
java.lang.String	getRows(IExecContext execContext) Number of rows to return for a query
int	getRowsAsInt(IExecContext execContext)
int	getTotalRows() total rows returned for count(*) of query.
java.lang.String	getWhere()
boolean	isRemove_html()
boolean	isRow_index()
void	setField_list(FieldList field_list)
void	setForm(PresentationFormAction form)
void	setGroup_by(java.lang.String group_by)
void	setHeader_align(java.lang.String header_align)
void	setJoin(java.lang.String join)
void	setKey(java.lang.String key)
void	setOrder_by(java.lang.String order_by)
void	setOutput_format(java.lang.String output_format)
void	setPage(int page)
void	setPresentation_form(java.lang.String presentation_form)
void	setRemove_html(boolean remove_html)
void	setRow_height(java.lang.String row_height)
void	setRow_index(boolean rowIndex)
void	setRow_map_name(java.lang.String row_map_name)
void	setRows(java.lang.String rows)
void	setTotalRows(int totalRows)
void	setWhere(java.lang.String where)
java.lang.String	toString()
void	validateStorage(IExecContext execContext, java.lang.String errMsg) Validates that the data_source_ref, storage_ref and table_name are set.
void	validateStorage(java.lang.String errMsg) Validates that the data_source_ref, storage_ref and table_name are set.

Methods inherited from class org.xmlactions.pager.actions.form.drawing.DrawFormFields

addAttributes, addToExecContext, buildInputForEdit, buildTdLabel, buildTextAreaInputForAddAndEdit, buildTextInputForAddAndEdit, displayForAdd, displayForEdit, displayForList, displayForSearch, displayForView, getPresentation_name, getTooltip

Methods inherited from class org.xmlactions.pager.actions.form.CommonFormFields

getAlign, getAttributes, getCss, getDirection, getDisplay_as, getExpression, getHeader_name, getHeight, getHref, getId, getLabel_position, getName, getOnchange, getOnclick, getOnfocus, getOnselect, getPopulatorXml, getPostfix, getPrefix, getPresentation_name, getSnippet_ref, getSql, getStorage_config_ref, getStorage_config_ref, getTable_name, getTheme_name, getTheme_name, getTheme, getTheme, getTitle, getTooltip, getUri, getValign, getWidth, getWidth, getX, getX, getY, getY, getZindex, isVisible, setAlign, setAttributes, setCss, setDirection, setDisplay_as, setExpression, setHeader_name, setHeight, setHref, setId, setLabel_position, setName, setOnchange, setOnclick, setOnfocus, setOnselect, setPopulatorXml, setPostfix, setPrefix, setPresentation_name, setSnippet_ref, setSql, setStorage_config_ref, setTable_name, setTheme_name, setTheme, setTitle, setTooltip, setUri, setValign, setVisible, setWidth, setX, setY, setZindex

Methods inherited from class org.xmlactions.pager.actions.form.BaseFormAction

addButtonsToExecContext, addLinksToExecContext, buildButtons, buildHiddenInput, buildInput, buildLinks, buildPasswordInput, buildTextInput, findFormId, getButton, getButtons, getLink, getLinks, setButton, setLink, setLinks

Methods inherited from class org.xmlactions.action.actions.BaseAction

addChild, clearActions, doReplace, doReplace, getActions, getChild, getContent, getFirstValueFound, getParent, getReplacementContent, getReplacementMarker, isUsedForDisplay, processAction, setAction, setActions, setChild, setContent, setParent, setReplacementContent, setReplacementMarker, setUsedForDisplay

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xmlactions.pager.actions.form.FormDrawing

getId, getLinks, getTheme, getTheme, getTitle, getWidth, isVisible

Methods inherited from interface org.xmlactions.pager.actions.form.IStorageFormAction

getSql, getTable_name, setSql, setTable_name

Constructor Detail

List

public List()

Method Detail

execute

public java.lang.String execute(IExecContext execContext)
                         throws DBSQLException,
                                NestedActionException,
                                java.lang.ClassNotFoundException,
                                java.lang.InstantiationException,
                                java.lang.IllegalAccessException,
                                java.lang.reflect.InvocationTargetException,
                                java.lang.NoSuchMethodException,
                                BadXMLException,
                                java.io.IOException

Description copied from class: BaseAction

Executes an action

Specified by:

execute in class BaseAction

Parameters:

execContext - the application execution context

Returns:

a String for replacement and to execute any child actions, else null to skip over child actions.

Throws:

DBSQLException

NestedActionException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

java.lang.NoSuchMethodException

BadXMLException

java.io.IOException

getTotalRows

public int getTotalRows()

total rows returned for count(*) of query. This will only have a valid value if there was one or more rows returned for the query.

setTotalRows

public void setTotalRows(int totalRows)

drawDivValue

public HtmlDiv drawDivValue(IDrawParams params,
                            java.lang.String fieldPresentationData,
                            Theme theme)

drawRowValue

public HtmlTd drawRowValue(IDrawParams params,
                           Html[] fieldPresentationData,
                           Theme theme)

buildHeader

public HtmlTh buildHeader(CommonStorageField field,
                          Theme theme,
                          java.lang.String align)

buildHeader

public HtmlTh buildHeader(java.lang.String tooltip,
                          java.lang.String presentationName,
                          Theme theme,
                          java.lang.String align)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setRows

public void setRows(java.lang.String rows)

getRowsAsInt

public int getRowsAsInt(IExecContext execContext)

getRows

public java.lang.String getRows()

Number of rows to return for a query

getRows

public java.lang.String getRows(IExecContext execContext)

Number of rows to return for a query

setPage

public void setPage(int page)

getPage

public int getPage()

setHeader_align

public void setHeader_align(java.lang.String header_align)

getHeader_align

public java.lang.String getHeader_align()

setField_list

public void setField_list(FieldList field_list)

getField_list

public FieldList getField_list()

setWhere

public void setWhere(java.lang.String where)

getWhere

public java.lang.String getWhere()

setJoin

public void setJoin(java.lang.String join)

getJoin

public java.lang.String getJoin()

setRow_height

public void setRow_height(java.lang.String row_height)

getRow_height

public java.lang.String getRow_height()

getHiddenFields

public java.util.List<HtmlInput> getHiddenFields()

Specified by:

getHiddenFields in interface FormDrawing

getExecContext

public IExecContext getExecContext()

Specified by:

getExecContext in interface FormDrawing

validateStorage

public void validateStorage(java.lang.String errMsg)

Validates that the data_source_ref, storage_ref and table_name are set.

Specified by:

validateStorage in interface IStorageFormAction

Parameters:

errMsg -

validateStorage

public void validateStorage(IExecContext execContext,
                            java.lang.String errMsg)

Validates that the data_source_ref, storage_ref and table_name are set.

Parameters:

errMsg -

isRow_index

public boolean isRow_index()

setRow_index

public void setRow_index(boolean rowIndex)

setOrder_by

public void setOrder_by(java.lang.String order_by)

getOrder_by

public java.lang.String getOrder_by()

setGroup_by

public void setGroup_by(java.lang.String group_by)

getGroup_by

public java.lang.String getGroup_by()

setPresentation_form

public void setPresentation_form(java.lang.String presentation_form)

getPresentation_form

public java.lang.String getPresentation_form()

getOutput_format

public java.lang.String getOutput_format()

Returns:

the output_format

setOutput_format

public void setOutput_format(java.lang.String output_format)

Parameters:

output_format - the output_format to set

isRemove_html

public boolean isRemove_html()

setRemove_html

public void setRemove_html(boolean remove_html)

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String key)

getForm

public PresentationFormAction getForm()

setForm

public void setForm(PresentationFormAction form)

getRow_map_name

public java.lang.String getRow_map_name()

Returns:

the row_map_name

setRow_map_name

public void setRow_map_name(java.lang.String row_map_name)

Parameters:

row_map_name - the row_map_name to set