org.xmlactions.pager.actions.form

Class ListCP

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.ListCP

All Implemented Interfaces:

FormDrawing, IForm, IStorageFormAction

public class ListCP
extends CommonFormFields
implements IForm, FormDrawing, IStorageFormAction

List Control Panel

Presents the control options for a list. These are next, prev, first, last and page.

It may also control the sort order. Lets see how it goes first. We might make a separate control for managing the sort order.

Field Summary

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

CHILD, CONTENT

Constructor Summary

Constructors

Constructor and Description
ListCP()

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute(IExecContext execContext) Draw the List Control Panel
java.lang.String	getControl_panel_position()
IExecContext	getExecContext()
java.lang.String	getForm_id()
java.lang.String	getFormId() will have an id.
java.util.List<HtmlInput>	getHiddenFields()
List	getList()
java.lang.String	getMethod()
java.lang.String	getScript_after()
java.lang.String	getScript_before()
Search	getSearch()
boolean	isAjax_load()
boolean	isShow_pagination()
void	setAjax_load(boolean ajax_load)
void	setControl_panel_position(java.lang.String control_panel_position)
void	setForm_id(java.lang.String form_id)
void	setList(List list)
void	setMethod(java.lang.String method)
void	setScript_after(java.lang.String script_after)
void	setScript_before(java.lang.String script_before)
void	setSearch(Search search)
void	setShow_pagination(boolean show_pagination)
void	validateParams(java.lang.String errMsg)
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.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, toString, 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

ListCP

public ListCP()

Method Detail

execute

public java.lang.String execute(IExecContext execContext)
                         throws java.lang.Exception

Draw the List Control Panel

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:

java.lang.Exception

setSearch

public void setSearch(Search search)

getSearch

public Search getSearch()

setList

public void setList(List list)

getList

public List getList()

setMethod

public void setMethod(java.lang.String method)

getMethod

public java.lang.String getMethod()

getExecContext

public IExecContext getExecContext()

Specified by:

getExecContext in interface FormDrawing

getHiddenFields

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

Specified by:

getHiddenFields in interface FormDrawing

validateStorage

public void validateStorage(java.lang.String errMsg)

Description copied from interface: IStorageFormAction

Validates that the data_source_ref, storage_ref and table_name are set.

Specified by:

validateStorage in interface IStorageFormAction

validateParams

public void validateParams(java.lang.String errMsg)

setControl_panel_position

public void setControl_panel_position(java.lang.String control_panel_position)

getControl_panel_position

public java.lang.String getControl_panel_position()

getFormId

public java.lang.String getFormId()

Description copied from interface: IForm

will have an id.

Specified by:

getFormId in interface IForm

Returns:

the form id.

setForm_id

public void setForm_id(java.lang.String form_id)

getForm_id

public java.lang.String getForm_id()

isAjax_load

public boolean isAjax_load()

setAjax_load

public void setAjax_load(boolean ajax_load)

getScript_before

public java.lang.String getScript_before()

setScript_before

public void setScript_before(java.lang.String script_before)

getScript_after

public java.lang.String getScript_after()

setScript_after

public void setScript_after(java.lang.String script_after)

isShow_pagination

public boolean isShow_pagination()

setShow_pagination

public void setShow_pagination(boolean show_pagination)