Examples of org.apache.click.Control

org.apache.click.Control
Provides the interface for Page controls. Controls are also referred to as components or widgets.
When a Page request event is processed Controls may perform server side event processing through their {@link #onProcess()} method. Controls are generallyrendered in a Page by calling their toString() method.
The Control execution sequence is illustrated below:

HTML Header Imports
Control HTML header imports can be exposed by overriding the {@link #getHtmlImports()} method.
For example a custom TextField control specifies that the custom.js file should be included in the HTML header imports:
```
 public class CustomField extends TextField { protected static final String HTML_IMPORT = "<script type=\"text/javascript\" src=\"{0}/click/custom.js\"></script>\n"; public String getHtmlImports() { String[] args = { getContext().getRequest().getContextPath() }; return MessageFormat.format(HTML_IMPORTS, args); } .. } 
```
Please note multiple import lines should be separated by a '\n' char, as the {@link org.apache.click.util.PageImports} will parse multiple import lineson the '\n' char and ensure that imports are not included twice.
Deploying Resources
The Click framework uses the Velocity Tools WebappLoader for loading templates. This avoids issues associate with using the Velocity ClasspathResourceLoader and FileResourceLoader on J2EE application servers. To make preconfigured resources (templates, stylesheets, etc.) available to web applications Click automatically deploys configured classpath resources to the /click directory at startup (existing files will not be overwritten).
To enable Controls to deploy static resources on startup this interface provides an {@link #onDeploy(ServletContext)} method.
Continuing our example the CustomField control deploys its custom.js file to the /click directory:
```
 public class CustomField extends TextField { .. public void onDeploy(ServletContext servletContext) { ClickUtils.deployFile (servletContext, "/com/mycorp/control/custom.js", "click"); } } 
```
Controls using the onDeploy() method must be registered in the application WEB-INF/click.xml for them to be invoked. For example:
```
 <click-app> <pages package="com.mycorp.page" automapping="true"/> <controls> <control classname="com.mycorp.control.CustomField"/> </controls> </click-app> 
```
When the Click application starts up it will deploy any control elements defined in the following files in sequential order:
- /click-controls.xml
- /extras-controls.xml
- WEB-INF/click.xml
Click also supports an alternative deployment strategy which relies on packaging resource (stylesheets, JavaScript, images etc.) following a specific convention. See the section Deploying Custom Resources for further details.
Please note {@link org.apache.click.control.AbstractControl} providesa default implementation of the Control interface to make it easier for developers to create their own controls. @see org.apache.click.util.PageImports

                    "'control' element missing 'classname' attribute.";
                throw new RuntimeException(msg);
            }


            Class deployClass = ClickUtils.classForName(classname);
            Control control = (Control) deployClass.newInstance();


            control.onDeploy(servletContext);
        }
    }

View Full Code Here

    public Control insert(Control control, int index) {


        // Check if container already contains the control
        String controlName = control.getName();
        if (controlName != null) {
            Control currentControl = getControlMap().get(controlName);


            // If container already contains the control do a replace
            if (currentControl != null
                && !(control instanceof Label)) {

View Full Code Here

        if (currentControl == newControl) {
            return newControl;
        }


        int controlIndex = getControls().indexOf(currentControl);
        Control result = ContainerUtils.replace(this, currentControl, newControl,
            controlIndex, getControlMap());


        if (newControl instanceof Field) {
            Field field = (Field) newControl;

View Full Code Here

     *
     * @param name the name of the field to remove from the form
     * @return true if the named field was removed or false otherwise
     */
    public boolean removeField(String name) {
        Control control = getControl(name);


        if (control != null) {
            return remove(control);


        } else {

View Full Code Here

     *
     * @throws IllegalStateException if a non-field control is found with the
     * specified name
     */
    public Field getField(String name) {
        Control control = ContainerUtils.findControlByName(this, name);


        if (control != null && !(control instanceof Field)) {
            throw new IllegalStateException("The control named " + name
                + " is an instance of the class " + control.getClass().getName()
                + ", which is not a " + Field.class.getName() + " subclass.");
        }
        return (Field) control;
    }

View Full Code Here


        boolean continueProcessing = true;
        if (isFormSubmission()) {


            for (int i = 0, size = getControls().size(); i < size; i++) {
                Control control = getControls().get(i);
                String controlName = control.getName();
                if (controlName == null || !controlName.startsWith(Form.SUBMIT_CHECK)) {


                    if (!control.onProcess()) {
                        continueProcessing = false;
                    }
                }
            }

View Full Code Here

    public Control insert(Control control, int index) {
        // Check if panel already contains the control
        String controlName = control.getName();
        if (controlName != null) {
            // Check if container already contains the control
            Control currentControl = getControlMap().get(control.getName());


            // If container already contains the control do a replace
            if (currentControl != null) {


                // Current control and new control are referencing the same object

View Full Code Here

    @Override
    public void onInit() {
        initActivePanel();


        for (int i = 0, size = getControls().size(); i < size; i++) {
            Control control = getControls().get(i);
            if (control instanceof Panel) {
                if (control == getActivePanel()) {
                    control.onInit();
                }
            } else {
                control.onInit();
            }
        }
    }

View Full Code Here

    @Override
    public boolean onProcess() {
        boolean continueProcessing = true;


        for (int i = 0, size = getControls().size(); i < size; i++) {
            Control control = getControls().get(i);
            if (control instanceof Panel) {
                if (control == getActivePanel()) {
                    if (!control.onProcess()) {
                        continueProcessing = false;
                    }
                }
            } else {
                if (!control.onProcess()) {
                    continueProcessing = false;
                }
            }
        }
        if (getTabLink().isClicked()) {

View Full Code Here

     * @see org.apache.click.Control#onRender()
     */
    @Override
    public void onRender() {
        for (int i = 0, size = getControls().size(); i < size; i++) {
            Control control = getControls().get(i);
            if (control instanceof Panel) {
                if (control == getActivePanel()) {
                    control.onRender();
                }
            } else {
                control.onRender();
            }
        }
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.click.Control

org.apache.click.control.AbstractContainer

org.apache.click.control.Field

org.apache.click.control.FieldSet

org.apache.click.control.Form

org.apache.click.control.Panel

org.apache.click.control.Table

org.apache.click.examples.control.exporter.TableExportContainer

org.apache.click.extras.control.AbstractContainerField

org.apache.click.extras.control.HtmlFieldSet

org.apache.click.extras.control.HtmlForm

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

HTML Header Imports

Deploying Resources

Related Classes of org.apache.click.Control