Serialized Form

Package org.apache.click

Class org.apache.click.ClickServlet extends HttpServlet implements Serializable

serialVersionUID: 1L

Serialized Fields

configService

ConfigService configService

The click application configuration service.

logger

LogService logger

The application log service.

memberAccess

ognl.MemberAccess memberAccess

The OGNL member access handler.

resourceService

ResourceService resourceService

The application resource service.

typeConverter

ognl.TypeConverter typeConverter

The request parameters OGNL type converter.

Class org.apache.click.Page extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

controls

List<E> controls

The list of page controls.

headElements

List<E> headElements

The list of page HTML HEAD elements including: Javascript imports, Css imports, inline Javascript and inline Css.

format

Format format

The Velocity template formatter object.

forward

String forward

The forward path.

headers

Map<K,V> headers

The HTTP response headers.

model

Map<K,V> model

The page model. For Velocity templates the model is used to populate the Velocity context. For JSP pages the model values are set as named request attributes.

path

String path

The path of the page template to render.

redirect

String redirect

The redirect path.

stateful

boolean stateful

Deprecated. stateful pages are not supported anymore, use stateful Controls instead

The page is stateful and should be saved to the users HttpSession between requests, default value is false.

template

String template

The path of the page border template to render.

includeControlHeadElements

boolean includeControlHeadElements

Indicates whether Control head elements should be included in the page template, default value is true.

Package org.apache.click.control

Class org.apache.click.control.AbstractContainer extends AbstractControl implements Serializable

serialVersionUID: 1L

Serialized Fields

controls

List<E> controls

The list of controls.

controlMap

Map<K,V> controlMap

The map of controls keyed by field name.

Class org.apache.click.control.AbstractControl extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

actionListener

ActionListener actionListener

The control's action listener.

behaviors

Set<E> behaviors

The control's list of behaviors.

headElements

List<E> headElements

The list of page HTML HEAD elements including: Javascript imports, Css imports, inline Javascript and inline Css.

attributes

Map<K,V> attributes

The Control attributes Map.

name

String name

The Control name.

parent

Object parent

The control's parent.

styles

Map<K,V> styles

Deprecated. use AbstractControl.addStyleClass(String) and AbstractControl.removeStyleClass(String) instead.

The Map of CSS style attributes.

listener

Object listener

The listener target object.

listenerMethod

String listenerMethod

The listener method name.

Class org.apache.click.control.AbstractLink extends AbstractControl implements Serializable

serialVersionUID: 1L

Serialized Fields

disabled

boolean disabled

The Field disabled value.

imageSrc

String imageSrc

The image src path attribute. If the image src is defined then a <img/> element will rendered inside the anchor link when using the AbstractLink AbstractControl.toString() method.

If the image src value is prefixed with '/' then the request context path will be prefixed to the src value when rendered by the control.

label

String label

The link display label.

parameters

Map<K,V> parameters

The link parameters map.

tabindex

int tabindex

The link 'tabindex' attribute.

title

String title

The link title attribute, which acts as a tooltip help message.

renderLabelAndImage

boolean renderLabelAndImage

Flag to set if both icon and text are rendered, default value is false.

Class org.apache.click.control.ActionButton extends Button implements Serializable

serialVersionUID: 1L

Serialized Fields

clicked

boolean clicked

The button is clicked.

parameters

Map<K,V> parameters

The button parameters map.

Class org.apache.click.control.ActionLink extends AbstractLink implements Serializable

serialVersionUID: 1L

Serialized Fields

clicked

boolean clicked

The link is clicked.

Class org.apache.click.control.Button extends Field implements Serializable

serialVersionUID: 1L

Class org.apache.click.control.Checkbox extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

checked

boolean checked

The field checked value.

Class org.apache.click.control.Column extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

attributes

Map<K,V> attributes

The Column attributes Map.

autolink

boolean autolink

The automatically hyperlink column URL and email address values flag, default value is false.

dataClass

String dataClass

The column table data <td> CSS class attribute.

dataStyles

Map<K,V> dataStyles

The Map of column table data <td> CSS style attributes.

decorator

Decorator decorator

The column row decorator.

escapeHtml

boolean escapeHtml

The escape HTML characters flag. The default value is true.

format

String format

The column message format pattern.

headerClass

String headerClass

The CSS class attribute of the column header.

headerStyles

Map<K,V> headerStyles

The Map of column table header <th> CSS style attributes.

headerTitle

String headerTitle

The title of the column header.

maxLength

int maxLength

The maximum column length. If maxLength is greater than 0 and the column data string length is greater than maxLength, the rendered value will be truncated with an eclipse(...).

Autolinked email or URL values will not be constrained.

The default value is 0.

messageFormat

MessageFormat messageFormat

The optional MessageFormat used to render the column table cell value.

name

String name

The property name of the row object to render.

renderId

Boolean renderId

The column render id attribute status. The default value is false.

sortable

Boolean sortable

The column sortable status. The default value is false.

table

Table table

The parent Table.

titleProperty

String titleProperty

The property name used to populate the <td> "title" attribute. The default value is null.

width

String width

The column HTML <td> width attribute.

comparator

Comparator<T> comparator

The column comparator object, which is used to sort column row values.

Class org.apache.click.control.Field extends AbstractControl implements Serializable

serialVersionUID: 1L

Serialized Fields

disabled

boolean disabled

The Field disabled value.

error

String error

The Field error message.

focus

boolean focus

The request focus flag.

form

Form form

The parent Form.

help

String help

The Field help text.

label

String label

The Field label.

labelStyle

String labelStyle

The field label "style" attribute value.

labelStyleClass

String labelStyleClass

The field label "class" attribute value.

parentStyleHint

String parentStyleHint

The field's parent element "style" attribute hint.

parentStyleClassHint

String parentStyleClassHint

The field's parent element "class" attribute hint.

readonly

boolean readonly

The Field is readonly flag.

required

boolean required

The Field is required flag.

tabindex

int tabindex

The Field 'tabindex' attribute.

title

String title

The Field 'title' attribute, which acts as a tooltip help message.

trim

boolean trim

The Field is trimmed flag, default value is true.

validate

Boolean validate

The validate Field value onProcess() invocation flag.

value

String value

The Field value.

Class org.apache.click.control.FieldSet extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

controls

List<E> controls

The list of controls.

controlMap

Map<K,V> controlMap

The map of controls keyed by field name.

fieldList

List<E> fieldList

The ordered list of fields, excluding buttons.

fieldWidths

Map<K,V> fieldWidths

The map of field width values.

legend

String legend

The FieldSet legend.

legendAttributes

Map<K,V> legendAttributes

The FieldSet legend attributes map.

showBorder

boolean showBorder

The render fieldset border flag, default value is true.

columns

Integer columns

This property serves as a hint to the number of table columns the fieldset is rendered with.

Currently only Form acts upon this property.

Class org.apache.click.control.FileField extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

size

int size

The text field size attribute. The default size is 20.

fileItem

FileItem fileItem

The DefaultFileItem after processing a file upload request.

Class org.apache.click.control.Form extends AbstractContainer implements Serializable

serialVersionUID: 1L

Serialized Fields

actionURL

String actionURL

The form action URL.

disabled

boolean disabled

The form disabled value.

enctype

String enctype

The form "enctype" attribute.

error

String error

The form level error message.

fieldList

List<E> fieldList

The ordered list of fields, excluding buttons.

method

String method

The form method ["post, "get"], default value: post.

readonly

boolean readonly

The form is readonly flag.

validate

boolean validate

The form validate fields when processing flag.

buttonAlign

String buttonAlign

The button align, default value is "left".

buttonList

List<E> buttonList

The ordered list of button values.

buttonStyle

String buttonStyle

The button <td> "style" attribute value.

columns

int columns

The number of form layout table columns, default value: 1.

This property is used to layout the number of table columns the form is rendered with using a flow layout style.

defaultFieldSize

int defaultFieldSize

The default field size, default value: 0.

If the form default field size is greater than 0, when fields are added to the form the field's size will be set to the default value.

errorsAlign

String errorsAlign

The errors block align, default value is "left".

errorsPosition

String errorsPosition

The form errors position ["top", "middle", "bottom"] default value: "top".

errorsStyle

String errorsStyle

The error <td> "style" attribute value.

fieldStyle

String fieldStyle

The field <td> "style" attribute value.

fieldWidths

Map<K,V> fieldWidths

The map of field width values.

formSubmission

Boolean formSubmission

Flag indicating whether this form was submitted.

javaScriptValidation

boolean javaScriptValidation

The JavaScript client side form fields validation flag. By default JavaScript validation is not enabled.

labelAlign

String labelAlign

The label align, default value is "left".

labelsPosition

String labelsPosition

The form labels position ["left", "top"] default value: "left".

labelStyle

String labelStyle

The label <td> "style" attribute value.

insertIndexOffset

int insertIndexOffset

Track the index offset when adding Controls. This ensures HiddenFields added by Form does not interfere with Controls added by users.

Class org.apache.click.control.HiddenField extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

valueObject

Object valueObject

The field value Object.

valueClass

Class<T> valueClass

The field value Class.

Class org.apache.click.control.ImageSubmit extends Submit implements Serializable

serialVersionUID: 1L

Serialized Fields

src

String src

The image path src attribute. If the src value is prefixed with '/' then the request context path will be prefixed to the src value when rendered by the control.

x

int x

The image pixel x coordinate clicked on by the user, the default value is -1. A value of -1 which means the value has not been set.

y

int y

The image pixel y coordinate clicked on by the user, the default value is -1. A value of -1 means the value has not been set.

Class org.apache.click.control.Label extends Field implements Serializable

serialVersionUID: 1L

Class org.apache.click.control.Option extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

label

String label

The Options display label.

value

String value

The Option value.

Class org.apache.click.control.OptionGroup extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

children

List<E> children

The groups child Option/OptGroup objects.

label

String label

The label for the OptionGroup.

Class org.apache.click.control.PageLink extends AbstractLink implements Serializable

serialVersionUID: 1L

Serialized Fields

pageClass

Class<T> pageClass

The target page class.

Class org.apache.click.control.Panel extends AbstractContainer implements Serializable

serialVersionUID: 1L

Serialized Fields

disabled

boolean disabled

The panel disabled value.

id

String id

The "identifier" for this panel (CSS id for rendering).

label

String label

The (localized) label of this panel.

model

Map<K,V> model

A temporary storage for model objects until the Page is set.

panels

List<E> panels

The list of sub panels.

template

String template

The path of the template to render.

active

boolean active

The panel active value, "true" by default.

Class org.apache.click.control.PasswordField extends TextField implements Serializable

serialVersionUID: 1L

Class org.apache.click.control.Radio extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

checked

boolean checked

The field checked value.

Class org.apache.click.control.RadioGroup extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

radioList

List<E> radioList

The list of Radio controls.

isVerticalLayout

boolean isVerticalLayout

The layout is vertical flag (default false). If the layout is vertical each Radio controls is rendered on a new line using the <br> tag.

Class org.apache.click.control.Reset extends Button implements Serializable

serialVersionUID: 1L

Class org.apache.click.control.Select extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

multiple

boolean multiple

The multiple options selectable flag. The default value is false.

optionList

List<E> optionList

The Select Option/OptionGroup list.

size

int size

The Select display size in rows. The default size is one.

selectedValues

List<E> selectedValues

The multiple selected values. This list will only be populated if Select.multiple is true.

dataProvider

DataProvider<T> dataProvider

The select data provider.

defaultOption

Option defaultOption

The default option will be the first option added to the Select. This property is often used when populating the Select from a Select.setDataProvider(org.apache.click.dataprovider.DataProvider), where the DataProvider does not return a sensible default option e.g. an empty ("") option.

Class org.apache.click.control.Submit extends Button implements Serializable

serialVersionUID: 1L

Serialized Fields

clicked

boolean clicked

The button is clicked.

Class org.apache.click.control.Table extends AbstractControl implements Serializable

serialVersionUID: 1L

Serialized Fields

bannerPosition

int bannerPosition

The table pagination banner position: [ POSITION_TOP | POSITION_BOTTOM | POSITION_BOTH ]. The default position is POSITION_BOTTOM.

caption

String caption

The table HTML <caption> element.

columns

Map<K,V> columns

The map of table columns keyed by column name.

columnList

List<E> columnList

The list of table Columns.

controlLink

ActionLink controlLink

The table paging and sorting control action link.

controlList

List<E> controlList

The list of table controls.

height

String height

The table HTML <td> height attribute.

dataProvider

DataProvider<T> dataProvider

The table data provider.

rowCount

int rowCount

The total possible number of rows of the table. This value could be much larger than the number of entries in the Table.rowList, indicating that some rows have not been loaded yet.

hoverRows

boolean hoverRows

The table rows set 'hover' CSS class on mouseover events flag. By default hoverRows is false.

nullifyRowListOnDestroy

boolean nullifyRowListOnDestroy

Deprecated. stateful pages are not supported anymore, use stateful Controls instead

Flag indicating if rowList is nullified when onDestroy() is invoked, default is true. This flag only applies to stateful pages.

See Also:

Table.setNullifyRowListOnDestroy(boolean)

pageNumber

int pageNumber

The currently displayed page number. The page number is zero indexed, i.e. the page number of the first page is 0.

pageSize

int pageSize

The maximum page size in rows. A value of 0 means there is no maximum page size.

paginator

Renderable paginator

The paginator used to render the table pagination controls.

paginatorAttachment

int paginatorAttachment

The paginator attachment style: [ PAGINATOR_ATTACHED | PAGINATOR_DETACHED | PAGINATOR_INLINE ]. The default paginator attachment type is PAGINATOR_ATTACHED.

renderId

boolean renderId

The default column render id attribute status. The default value is false.

rowList

List<E> rowList

The list Table rows. Please note the rowList is cleared in table Table.onDestroy() method at the end of each request.

showBanner

boolean showBanner

The show table banner flag detailing number of rows and current rows displayed.

sortable

boolean sortable

The default column are sortable status. By default columnsSortable is false.

sorted

boolean sorted

The row list is sorted status. By default sorted is false.

sortedAscending

boolean sortedAscending

The rows list is sorted in ascending order.

sortedColumn

String sortedColumn

The name of the sorted column.

width

String width

The table HTML <td> width attribute.

Class org.apache.click.control.TablePaginator extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

table

Table table

The parent table to provide paginator for.

Class org.apache.click.control.TextArea extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

cols

int cols

The number of text area columns. The default number of columns is twenty.

maxLength

int maxLength

The maximum field length validation constraint. If the value is zero this validation constraint is not applied. The default value is zero.

minLength

int minLength

The minimum field length validation constraint. If the valid is zero this validation constraint is not applied. The default value is zero.

rows

int rows

The number of text area rows. The default number of rows is three.

Class org.apache.click.control.TextField extends Field implements Serializable

serialVersionUID: 1L

Serialized Fields

maxLength

int maxLength

The maximum field length validation constraint. If the value is zero this validation constraint is not applied. The default value is zero.

If maxLength is greater than zero, then maxLength is rendered as the HTML attribute 'maxlength'.

minLength

int minLength

The minimum field length validation constraint. If the valid is zero this validation constraint is not applied. The default value is zero.

size

int size

The text field size attribute. The default size is 20.

Package org.apache.click.dataprovider

Package org.apache.click.element

Class org.apache.click.element.CssImport extends ResourceElement implements Serializable

serialVersionUID: 1L

Class org.apache.click.element.CssStyle extends ResourceElement implements Serializable

serialVersionUID: 1L

Serialized Fields

content

String content

The inline Css content.

characterData

boolean characterData

Indicates if the HeadElement's content should be wrapped in a CDATA tag.

template

String template

The path of the template to render.

model

Map<K,V> model

The model of the template to render.

Class org.apache.click.element.Element extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

attributes

Map<K,V> attributes

The Element attributes Map.

Class org.apache.click.element.JsImport extends ResourceElement implements Serializable

serialVersionUID: 1L

Class org.apache.click.element.JsScript extends ResourceElement implements Serializable

serialVersionUID: 1L

Serialized Fields

content

String content

The inline JavaScript content.

characterData

boolean characterData

Indicates if the JsScript's content should be wrapped in a CDATA tag.

executeOnDomReady

boolean executeOnDomReady

Indicates the JsScript content must be executed as soon as the browser DOM is available, default value is false.

template

String template

The path of the template to render.

model

Map<K,V> model

The model of the template to render.

Class org.apache.click.element.ResourceElement extends Element implements Serializable

serialVersionUID: 1L

Serialized Fields

conditionalComment

String conditionalComment

The Internet Explorer conditional comment to wrap the Resource with.

renderId

boolean renderId

Indicates whether the ID attribute should be rendered or not, default value is true.

versionIndicator

String versionIndicator

The version indicator to append to the Resource element.

Package org.apache.click.service

Class org.apache.click.service.TemplateException extends Exception implements Serializable

serialVersionUID: 1L

Serialized Fields

columnNumber

int columnNumber

The template column number where this exception occurred.

lineNumber

int lineNumber

The template the line number where this exception occurred.

templateName

String templateName

The Template name where this exception occurred.

Class org.apache.click.service.XmlConfigService.ExcludePage extends Page implements Serializable

Package org.apache.click.util

Class org.apache.click.util.ActionListenerAdaptor extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

listener

Object listener

Deprecated.

The target listener object.

method

String method

Deprecated.

The target listener method name.

Class org.apache.click.util.ErrorPage extends Page implements Serializable

serialVersionUID: 1L

Serialized Fields

error

Throwable error

The error causing exception.

mode

String mode

The application mode: ["production", "profile", "development", "debug", "trace"].

pageClass

Class<T> pageClass

The page class in error.

Class org.apache.click.util.FlashAttribute extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

value

Object value

The session attribute value.

Class org.apache.click.util.Format extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

locale

Locale locale

The request context locale.

emptyString

String emptyString

The empty string value.