Examples of org.apache.click.control.Field

org.apache.click.control.Field
Provides an abstract form Field control. Field controls are contained by the {@link Form} control which will orchestrate the processing andrendering of the contained fields. All Form field controls must extend this abstract class.
Field Processing

Post Requests
When processing POST requests forms typically invoke the {@link #onProcess()}method on all its fields. The Field onProcess() method is used to bind the fields request value, validate the submission and invoke any control listener method. If the onProcess() method returns true the form will continue processing fields, otherwise the form will abort further processing.
The body of the Field onProcess() method is detailed below.
```
 public boolean onProcess() { bindRequestValue(); if (getValidate()) { validate(); } registerActionEvent(); return true; } 
```
The Field methods called by onProcess() include:

{@link #bindRequestValue()}

This method will bind the HTTP request value to the Field's value.

{@link #getValidate()}

This method will return true if the Field should validate itself. This value is generally inherited from the parent Form, however the Field can override this value and specify whether it should be validated.

{@link #validate()}

This method will validate the submitted Field value. If the submitted value is not valid this method should set the Field {@link #error} property,which can be rendered by the Form.

{@link #dispatchActionEvent()}

This method will register any Control action listener method which has be defined for the Field.

Field subclasses generally only have to override the validate() method, and possibly the bindRequestValue() method, to provide their own behaviour.
Get Requests
When processing GET requests a Page's Form will typically perform no processing and simply render itself and its Fields.
Rendering
Field subclasses must override the {@link #render(org.apache.click.util.HtmlStringBuffer)}method to enable themselves to be rendered as HTML. With the increasing use of AJAX, Fields should render themselves as valid XHTML, so that they may be parsed correctly and used as the innerHtml in the DOM.
When a Form object renders a Field using autolayout, it renders the Field in a table row using the Field's {@link #label} attribute, its{@link #error} attribute if defined, and the Fields{@link #render(org.apache.click.util.HtmlStringBuffer)} method.
To assist with rendering valid HTML Field subclasses can use the {@link org.apache.click.util.HtmlStringBuffer} class.
Message Resources
Fields support a hierarchy of resource bundles for displaying validation error messages and display messages. These localized messages can be accessed through the methods:
- {@link #getMessage(String)}
- {@link #getMessage(String,Object)}
- {@link #getMessage(String,Object[])}
- {@link #getMessages()}
- {@link #setErrorMessage(String)}
- {@link #setErrorMessage(String,Object)}
Fields automatically pick up localized messages where applicable. Please see the following methods on how to customize these messages:
- {@link #getLabel()}
- {@link #getTitle()}
- {@link #getHelp()}
- {@link #setErrorMessage(String)}
- {@link #setErrorMessage(String,Object)}
The order in which localized messages resolve are:
Page scope messages
Message lookups are first resolved to the Pages message bundle if it exists. For example a Login page may define the message properties:
```
 /com/mycorp/page/Login.properties 
```
If you want messages to be used only for a specific Page, this is where to place them.
Global page scope messages
Next message lookups are resolved to the global pages message bundle if it exists.
```
 /click-page.properties 
```
If you want messages to be used across your entire application this is where to place them.
Control scope messages
Next message lookups are resolved to the Control message bundle if it exists. For example a CustomTextField control may define the message properties:
```
 /com/mycorp/control/CustomTextField.properties 
```
Global control scope messages
Finally message lookups are resolved to the global application control message bundle if the message has not already found. The global control properties file is:
```
 /click-control.properties 
```
You can modify these properties by copying this file into your applications root class path and editing these properties.
Note when customizing the message properties you must include all the properties, not just the ones you want to override.

     *
     * @param pageNumber set the currently displayed page number
     */
    @Override
    public void setPageNumber(int pageNumber) {
        Field field = (Field) getForm().getFields().get(PAGE);
        if (field != null) {
            field.setValue(Integer.toString(pageNumber));
        }
        super.setPageNumber(pageNumber);
    }

View Full Code Here

        ActionLink controlLink = getControlLink();


        boolean continueProcessing = super.onProcess();


        if (!controlLink.isClicked() && getForm().isFormSubmission()) {
            Field pageField = getForm().getField(PAGE);
            pageField.onProcess();
            if (StringUtils.isNotBlank(pageField.getValue())) {
                setPageNumber(Integer.parseInt(pageField.getValue()));
            }


            Field columnField = getForm().getField(COLUMN);
            columnField.onProcess();
            setSortedColumn(columnField.getValue());


            Field ascendingField = getForm().getField(ASCENDING);
            ascendingField.onProcess();
            setSortedAscending("true".equals(ascendingField.getValue()));


            // Ensure data is retrieved before getRowCount can be called
            getRowList();


            // Range sanity check
            int pageNumber = Math.min(getPageNumber(), getRowCount() - 1);
            pageNumber = Math.max(pageNumber, 0);
            setPageNumber(pageNumber);


            //Have to sort list here before we process each field. Otherwise if
            //sortRowList() is only called in Table.toString(), the fields values set here
            //will not correspond to their rows in the rowList.
            sortRowList();


            int firstRow = 0;
            int lastRow = 0;


            if (getDataProvider() instanceof PagingDataProvider) {
                lastRow = getRowList().size();
            } else {
                firstRow = getFirstRow();
                lastRow = getLastRow();
            }


            List rowList = getRowList();
            List columnList = getColumnList();


            for (int i = firstRow; i < lastRow; i++) {
                Object row = rowList.get(i);


                for (int j = 0; j < columnList.size(); j++) {


                    Column column = (Column) columnList.get(j);


                    if (column instanceof FieldColumn) {
                        FieldColumn fieldColumn = (FieldColumn) column;
                        Field field = fieldColumn.getField();


                        if (field != null) {
                            field.setName(column.getName() + "_" + i);


                            field.onProcess();


                            if (field.isValid()) {
                                fieldColumn.setProperty(row, column.getName(),
                                    field.getValueObject());
                            } else {
                                getForm().setError(getMessage("formtable-error"));
                            }
                        }
                    }

View Full Code Here

        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = container.getControls().get(i);
            if (control instanceof Container) {
                // Include fields but skip fieldSets
                if (control instanceof Field) {
                    Field field = (Field) control;
                    bindField(field, context);


                } else if (control instanceof AbstractLink) {
                    ((AbstractLink) control).bindRequestValue();
                }
                Container childContainer = (Container) control;
                bind(childContainer, context);


            } else if (control instanceof Field) {
                Field field = (Field) control;
                bindField(field, context);


            } else if (control instanceof AbstractLink) {
                ((AbstractLink) control).bindRequestValue();
            }

View Full Code Here

        boolean result = super.onProcess();


        if (!isValid()) {
            List<Field> errorFields = getErrorFields();
            if (!errorFields.isEmpty()) {
                Field field = errorFields.get(0);
                int sheetNumber = getTabSheetNumber(field.getName());
                setDisplayTab(sheetNumber);
            }
        }


        return result;

View Full Code Here

                continue;


            } else if (control instanceof Container) {
                // Include fields but skip fieldSets
                if (control instanceof Field && !(control instanceof FieldSet)) {
                    Field field = (Field) control;
                    if (field.isHidden()) {
                        fields.add((Field) control);
                    }
                }


                Container childContainer = (Container) control;
                addHiddenFields(childContainer, fields);


            } else if (control instanceof Field) {
                Field field = (Field) control;
                if (field.isHidden()) {
                    fields.add((Field) control);
                }
            }
        }
    }

View Full Code Here

                // Skip buttons
                continue;


            } else if (control instanceof Container) {
                if (control instanceof Field) {
                    Field field = (Field) control;
                    if (!field.isValid()
                        && !field.isHidden()
                        && !field.isDisabled()) {


                        fields.add((Field) control);
                    }
                }
                Container childContainer = (Container) control;
                addErrorFields(childContainer, fields);


            } else if (control instanceof Field) {
                Field field = (Field) control;
                if (!field.isValid()
                    && !field.isHidden()
                    && !field.isDisabled()) {


                    fields.add((Field) control);
                }
            }
        }

View Full Code Here

        // ------
        // Form 1
        form1.setColumns(3);


        // Row 1
        Field titleField = new TextField("title");
        titleField.setStyle("width", "100%");
        form1.add(titleField, 2);
        form1.add(new Label("blank", ""));


        // Row 2
        form1.add(new TextArea("description", 70, 3), 3);

View Full Code Here

                continue;


            } else if (control instanceof Container) {
                // Include fields but skip fieldSets
                if (control instanceof Field && !(control instanceof FieldSet)) {
                    Field field = (Field) control;
                    if (field.isHidden()) {
                        fields.add((Field) control);
                    }
                }


                Container childContainer = (Container) control;
                addHiddenFields(childContainer, fields);


            } else if (control instanceof Field) {
                Field field = (Field) control;
                if (field.isHidden()) {
                    fields.add((Field) control);
                }
            }
        }
    }

View Full Code Here

                // Skip buttons
                continue;


            } else if (control instanceof Container) {
                if (control instanceof Field) {
                    Field field = (Field) control;
                    if (!field.isValid()
                        && !field.isHidden()
                        && !field.isDisabled()) {


                        fields.add((Field) control);
                    }
                }
                Container childContainer = (Container) control;
                addErrorFields(childContainer, fields);


            } else if (control instanceof Field) {
                Field field = (Field) control;
                if (!field.isValid()
                    && !field.isHidden()
                    && !field.isDisabled()) {


                    fields.add((Field) control);
                }
            }
        }

View Full Code Here

    protected void renderTableDataContent(Object row, HtmlStringBuffer buffer,
            Context context, int rowIndex) {


        Object columnValue = getProperty(row);


        Field field = getField();


        //fallback to super implementation
        if (field == null) {
            super.renderTableDataContent(row, buffer, context, rowIndex);
            return;
        }


        field.setName(getName() + "_" + rowIndex);


        if (getTable() instanceof FormTable) {
            FormTable formTable = (FormTable) getTable();
            Form form = formTable.getForm();


            if (formTable.getRenderSubmittedValues()
                && form.isFormSubmission()) {


                field.onProcess();


                if (field.getError() != null) {
                    field.setTitle(field.getError());
                }


            } else {
                field.setTitle(null);
                field.setError(null);
                field.setValueObject(columnValue);
            }


            if (getDecorator() != null) {
                Object value = getDecorator().render(row, context);
                if (value != null) {
                    buffer.append(value);
                }


            } else {
                getField().render(buffer);
            }


        } else {
            field.setValueObject(columnValue);


            if (getDecorator() != null) {
                Object value = getDecorator().render(row, context);
                if (value != null) {
                    buffer.append(value);
                }


            } else {
                getField().render(buffer);
            }
        }


        field.setValue(null);
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.click.control.Field

org.apache.click.Context

org.apache.click.Control

org.apache.click.examples.control.html.FeedbackBorder

org.apache.click.examples.page.control.FieldSetDemo

org.apache.click.examples.page.form.ExtraControlsForm

org.apache.click.examples.page.form.FormLayout

org.apache.click.examples.page.form.StandardControlsForm

org.apache.click.examples.page.form.TabbedFormDemo

org.apache.click.extras.cayenne.CayenneForm

org.apache.click.extras.cayenne.CayenneUtils

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of org.apache.click.control.Field

Field Processing

Post Requests

Get Requests

Rendering

Message Resources

Related Classes of org.apache.click.control.Field