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

     * matching name
     * @param name the name of the control to find
     * @return the control which name matched the given name
     */
    public static Control findControlByName(Container container, String name) {
        Control control = (Control) container.getControl(name);


        if (control != null) {
            return control;


        } else {
            for (int i = 0; i < container.getControls().size(); i++) {
                Control childControl = (Control) container.getControls().get(i);


                if (childControl instanceof Container) {
                    Container childContainer = (Container) childControl;
                    Control found = findControlByName(childContainer, name);
                    if (found != null) {
                        return found;
                    }
                }
            }

View Full Code Here

     * @param container the container to obtain the fields from
     * @param buttons the list of contained fields
     */
    private static void addButtons(final Container container, final List buttons) {
        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = (Control) container.getControls().get(i);
            if (control instanceof Container) {
                // Include buttons that are containers
                if (control instanceof Button) {
                    buttons.add(control);
                }

View Full Code Here

     * @param container the container to obtain the fields from
     * @param the list of contained fields
     */
    private static void addFields(final Container container, final List fields) {
        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = (Control) container.getControls().get(i);
            if (control instanceof Container) {
                // Include fields that are containers
                if (control instanceof Field) {
                    fields.add(control);
                }

View Full Code Here

     * @param container the container to obtain the fields from
     * @param the list of contained fields
     */
    private static void addInputFields(final Container container, final List fields) {
        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = (Control) container.getControls().get(i);
            if (control instanceof Label || control instanceof Button) {
                // Skip buttons and labels
                continue;


            } else if (control instanceof Container) {

View Full Code Here

     * @param container the container to obtain the hidden fields from
     * @param the list of contained fields
     */
    private static void addHiddenFields(final Container container, final List fields) {
        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = (Control) container.getControls().get(i);
            if (control instanceof Label || control instanceof Button) {
                // Skip buttons and labels
                continue;
            } else if (control instanceof Container) {
                // Include fields but skip fieldSets

View Full Code Here

     * @param container the container to obtain the fields from
     * @param the list of contained fields
     */
    private static void addFieldsAndLabels(final Container container, final List fields) {
        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = (Control) container.getControls().get(i);
            if (control instanceof Button) {
                // Skip buttons
                continue;


            } else if (control instanceof Container) {

View Full Code Here

     * @param container the container to obtain the fields from
     * @param the map of contained fields
     */
    private static void addFields(final Container container, final Map fields) {
        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = (Control) container.getControls().get(i);
            if (control instanceof Container) {
                // Include fields that are containers
                if (control instanceof Field) {
                    fields.put(control.getName(), control);
                }
                Container childContainer = (Container) control;
                addFields(childContainer, fields);
            } else if (control instanceof Field) {
                fields.put(control.getName(), control);
            }
        }
    }

View Full Code Here

     * @return list of form fields which are not valid, not hidden and not
     *  disabled
     */
    private static void addErrorFields(final Container container, final List fields) {
        for (int i = 0; i < container.getControls().size(); i++) {
            Control control = (Control) container.getControls().get(i);
            if (control instanceof Button) {
                // Skip buttons
                continue;


            } else if (control instanceof Container) {

View Full Code Here

     *
     * @param controls the list of Controls which HEAD elements to process
     */
    public void processControls(List controls) {
        for (int i = 0; i < controls.size(); i++) {
            Control control = (Control) controls.get(i);


            // import from getHtmlImports
            addImport(control.getHtmlImports());


            // import from getHeadElement
            processControl(control);
        }
    }

View Full Code Here

                    "'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

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