wicket

The core Wicket package. The key core classes you will need to learn to do basic Wicket programming are:

• {@link wicket.Application} / {@link wicket.protocol.http.WebApplication} - Subclass WebApplication to create your application. Set your home page with Application.getPages().setHomePage(MyHomePage.class). Configure Wicket for deployment with Application.getSettings().configure("deployment"). Substitute "development" to get default settings for a development environment.
• {@link wicket.Component} - You will need to carefully study this class as Component is very central to Wicket. There are a large number of convenience methods in Component and, naturally, every component in Wicket is a subclass of Component, so all these methods are available to all Components.
• {@link wicket.IRequestCycleFactory} - If you are working with a persistence framework such as Hibernate or JDO, you may need to implement a request cycle factory in order to open a persistence session at the beginning of a request and close the session at the end of the request.
• {@link wicket.ISessionFactory} - For all but the most trivial applications, you will need to create your own session factory. Your implementation of this interface will generally be quite simple, generally just returning a new instance of your own application-specific subclass of WebSession.
• {@link wicket.MarkupContainer} - You will need to study MarkupContainer carefully as this class contains all the logic for creating and maintaining component hierarchies.
• {@link wicket.Page} / {@link wicket.markup.html.WebPage} - Every page in your wicket application will extend WebPage (or some other subclass of Page if you are writing something other than a web application). There are a number of important methods in Page and you should be familiar with all of them.
• {@link wicket.PageParameters} - A simple wrapper for query string parameters.
• {@link wicket.Session} / {@link wicket.protocol.http.WebSession} - It is particularly important to understand Session if you are doing clustering, but even for a very basic application you will want to create your own subclass of WebSession using a session factory so that you can store any session properties in a typesafe way. Note that since Pages are first class objects with models of their own, it is likely or at least possible that you will not have many session properties.

Contains classes that allow the user to specify authorization constraints via IAuthorizationStrategy. These constraints are then applied thoughout the framework to ensure security.

Classes that make debugging Wicket HTML applications easier.

Package for working with bread crumb components.

Bread crumbs provide a means to track certain history of client actions. Bread crumbs are typically rendered as a list of links, and are useful when users 'dig deeper' into the site structure so that they can find their way back again and have a notion of where they currently are.

Bread crumbs in the original sense just represent where people are in a site hierarchy. For example, when browsing a product site, bread crumbs could look like this:

           Home > Products & Solutions > Hardware > Desktop Systems
  

           World > Europe > The Netherlands > Utrecht
  

The central interface of this package is IBreadCrumbModel, which models the concept of bread crumbs. The main implementation of bread crumbs is the BreadCrumbBar, which is a Wicket component that renders the bread crumbs and an implementation of IBreadCrumbModel in one.

This package contains a panel based implementation of bread crumb participants. Basically, if you use BreadCrumbPanel with BreadCrumbBar, you'll have a working pattern of panel replacements and bread crumbs that keep track of them. See the breadcrumb example of wicket-examples.

Basic extensions.

Image resource extensions.

Package for working with tab panels.

Convenience models.

Encoding extensions.

Package for working with Wizard components. Wizards are dialogs which take users through a number of steps to achieve something.

The main component is wicket.extensions.wizard, which serves as the panel on which the whole wizard is rendered. It is possible to implement

wicket.extensions.wizard.IWizard directly, but it is not recommended. The wizard cooperates with an instance of wicket.extensions.wizard.IWizardModel, for which the default implementation wicket.extensions.wizard.WizardModel is provided. This model knows about the wizard's steps and the transitions between them, and it holds a reference to the currently active step. It might function as a generic state holder for the wizard too, though you might find it more convenient to use the wizard component itself for that, or even an external model. See the wizard example of the wicket-examples project for some examples of wizards.

The Swing Wizard Framework served as a valueable source of inspiration as did discussions with Michael Jouravlev and Tim Boudreau.

Classes related to showing user feedback, generally as the result of form submission and/or validation.

Exposes Wicket's settings via Java Management Extensions (JMX).

An easy way to enable JMX is to provide argument -Dcom.sun.management.jmxremote when starting up your application.

Base package for markup.

Base package of HTML markup.

Basic HTML components.

Border components.

HTML Forms and form components.

Persistence support for forms.

Support for upload forms (using multipart requests).

This package depends on package Commons FileUpload, version 1.0.

Support for form validation. Form components can have validations assigned, which are triggered before the models of the form components are updated. If validation fails, the denied input is re-displayed by the components, and the error messages are collected and available in FeedbackMessages.

Image components.

Resource support for image components.

Components for including content from non-Wicket sources.

Link components.

List components for tabular data and such.

Default special purpose pages for error and feedback support.

Panel components.

Support classes for HTML specific resources.

Package for Tree components.

The default parsing engine of Wicket.

Default parsing extensions.

Resolvers implement the IComponentResolver interface and must be registered with the application. Most of them are registered by default. Resolvers are used by Wicket to find the Component associated with markup (wicket:id) where the Component is not simply a child of the parent container.

Transformers are able to post-process (transform) the output generated by a Component. That might be XSLT, XQuery or any other processor. Transformers can be implemented as Container or IBehaviour. Both variants redirect the output to a StringResponse which at the end is used as input to the transformer. The output of transformer is than written to the original response.

Core model support for Wicket components.

HTTP implementation.

Test support for the HTTP implementation.

This package contains http (web) protocol dependent implementations of request processing strategies.

Java Servlet specific implementation of Wicket http classes.

Package for classes that have generic (protocol independent) support for request cycle processing. Provides the most important request target interfaces and classes.

Common implementations of request targets.

Additions to request targets.

Locale aware resouce loaders.

Several response implementations.

This package contains all the classes to make your wicket components and other pojos @SpringBean annotation aware.

To setup automatic injection of wicket components in your application subclass init() method call: addComponentInstantiationListener(new SpringComponentInjector(this)); To inject any pojo call InjectorHolder.getInjector().inject(this) in the pojo's constructor.

Useful collections.

Contains the classes for concurrency support.

This package provides standardized, efficient versions of utility classes commonly encountered in concurrent Java programming. This code consists of implementations of ideas that have been around for ages, and is merely intended to save you the trouble of coding them. Discussions of the rationale and applications of several of these classes can be found in the second edition of Concurrent Programming in Java. There are also pdf slides providing an overview of the package.

These classes were taken from concurrent.jar, version 1.3.4, provided by Doug Lea. Java 1.5 and later have these collections built in.

Conversion support.

Default converter implementations.

Encryption support for forms.

The {@link org.apache.maven.jrcs.diff diff} package implements the differencing engine that JRCS uses. The engine has the power of Unix diff, is simple to understand, and can be used independently of the archive handling functionality. The entry point to the differencing engine is class {@link org.apache.maven.jrcs.diff.Diff Diff}.

Text is represented as Object[] because the diff engine is capable of handling more than plain ascci. In fact, arrays of any type that implements {@link java.lang.Object#hashCode hashCode()} and {@link java.lang.Object#equals equals()} correctly can be subject to differencing using this library.

Two implementations of the differencing algorithm are provided.

• {@link SimpleDiff Simple Diff} is a verys imple algorithm that is fast and works well with very large input sequences, but that frequently produces result that are subotimal (at times four or more times larger than GNU diff).
• {@link org.apache.commons.jrcs.diff.myers.MyersDiff MyersDiff} is an implementation of Gene Myers differencing algorithm. Myer's algorithm produces optimum results (minimum diffs), but consumes considerably more memory than SimpleDiff, so its not suitable for very large files.

@author Juanco Anez
@version $Id: package.html,v 1.1 2006/03/12 00:24:21 juanca Exp $
@see Diff 
@see org.apache.maven.jrcs.rcs.Archive

The {@link org.apache.maven.jrcs.diff.myers diff.myers} package implements Gene Myers' differencing algorithm.

Myer's algorithm produces optimum results (minimum diffs), but consumes considerably more memory than SimpleDiff, so its not suitable for very large files.

File utilities.

Input/Output utilities. ByteArrayOutputStream, DeferredFileOutputStream, FileCleaner, ThresholdingOutputStream and IOUtils are copied from the Apache Jakarta Commons IO project (version 1.0). They are used by upload functions.

Java utilities.

Listener/ Observer utilities.

Regular Expressions meta pattern support.

Regular Expressions meta pattern parsers.

Base support for resources.

Locators for finding/ loading resources.

String utilities.

Support for String-variable interpolation.

Resource extensions that makes working with header contributions easier and better maintainable.

A package with utility classes to ease unit testing of Wicket applications without the need for a servlet container. The only classes required by users to test are WicketTester and FormTester. WicketTester extends MockWebApplication and extends it with convinience methods to start (render) a page and to test (assert) certain conditions.

FormTester is a utility class to make unit testing a HTML form a breeze.

Threading utilities.

Utilities for working with time(s).

Protocol independent upload utilities. Copied from the Apache Jakarta Commons FileUpload project (1.1-dev, HEAD at 21st of august 2005).

Casting utilities.

Modification observers.

This packages provides the default implementation of Wicket's back button support in the form of the ability to record and 'undo' changes to component composition structure, model changes and user specific (such as the current page of pageable lists) changes.

The core Wicket package. The key core classes you will need to learn to do basic Wicket programming are:

• {@link wicket.Application} / {@link wicket.protocol.http.WebApplication} - Subclass WebApplication to create your application. Set your home page with Application.getPages().setHomePage(MyHomePage.class). Configure Wicket for deployment with Application.getSettings().configure("deployment"). Substitute "development" to get default settings for a development environment.
• {@link wicket.Component} - You will need to carefully study this class as Component is very central to Wicket. There are a large number of convenience methods in Component and, naturally, every component in Wicket is a subclass of Component, so all these methods are available to all Components.
• {@link wicket.IRequestCycleFactory} - If you are working with a persistence framework such as Hibernate or JDO, you may need to implement a request cycle factory in order to open a persistence session at the beginning of a request and close the session at the end of the request.
• {@link wicket.ISessionFactory} - For all but the most trivial applications, you will need to create your own session factory. Your implementation of this interface will generally be quite simple, generally just returning a new instance of your own application-specific subclass of WebSession.
• {@link wicket.MarkupContainer} - You will need to study MarkupContainer carefully as this class contains all the logic for creating and maintaining component hierarchies.
• {@link wicket.Page} / {@link wicket.markup.html.WebPage} - Every page in your wicket application will extend WebPage (or some other subclass of Page if you are writing something other than a web application). There are a number of important methods in Page and you should be familiar with all of them.
• {@link wicket.PageParameters} - A simple wrapper for query string parameters.
• {@link wicket.Session} / {@link wicket.protocol.http.WebSession} - It is particularly important to understand Session if you are doing clustering, but even for a very basic application you will want to create your own subclass of WebSession using a session factory so that you can store any session properties in a typesafe way. Note that since Pages are first class objects with models of their own, it is likely or at least possible that you will not have many session properties.

Contains classes that allow the user to specify authorization constraints via IAuthorizationStrategy. These constraints are then applied thoughout the framework to ensure security.

Classes that make debugging Wicket HTML applications easier.

Package for working with bread crumb components.

Bread crumbs provide a means to track certain history of client actions. Bread crumbs are typically rendered as a list of links, and are useful when users 'dig deeper' into the site structure so that they can find their way back again and have a notion of where they currently are.

Bread crumbs in the original sense just represent where people are in a site hierarchy. For example, when browsing a product site, bread crumbs could look like this:

           Home > Products & Solutions > Hardware > Desktop Systems
  

           World > Europe > The Netherlands > Utrecht
  

The central interface of this package is IBreadCrumbModel, which models the concept of bread crumbs. The main implementation of bread crumbs is the BreadCrumbBar, which is a Wicket component that renders the bread crumbs and an implementation of IBreadCrumbModel in one.

This package contains a panel based implementation of bread crumb participants. Basically, if you use BreadCrumbPanel with BreadCrumbBar, you'll have a working pattern of panel replacements and bread crumbs that keep track of them. See the breadcrumb example of wicket-examples.

Basic extensions.

Provides a datepicker component.

Image resource extensions.

Package for working with tab panels.

Package for Tree components.

Convenience models.

Encoding extensions.

Resource extensions that makes working with header contributions easier and better maintainable.

Package for working with Wizard components. Wizards are dialogs which take users through a number of steps to acchieve something.

The main component is wicket.extensions.wizard, which serves as the panel on which the whole wizard is rendered. It is possible to implement

The Swing Wizard Framework served as a valueable source of inspiration as did discussions with Michael Jouravlev and Tim Boudreau.

Classes related to showing user feedback, generally as the result of form submission and/or validation.

Base package for markup.

Base package of HTML markup.

Basic HTML components.

Border components.

HTML Forms and form components.

Persistence support for forms.

Support for upload forms (using multipart requests).

This package depends on package Commons FileUpload, version 1.0.

Support for form validation. Form components can have validations assigned, which are triggered before the models of the form components are updated. If validation fails, the denied input is re-displayed by the components, and the error messages are collected and available in FeedbackMessages.

Image components.

Resource support for image components.

Components for including content from non-Wicket sources.

Link components.

List components for tabular data and such.

Default special purpose pages for error and feedback support.

Panel components.

Support classes for HTML specific resources.

Package for Tree components.

The default parsing engine of Wicket.

Default parsing extensions.

Resolvers implement the IComponentResolver interface and must be registered with the application. Most of them are registered by default. Resolvers are used by Wicket to find the Component associated with markup (wicket:id) where the Component is not simply a child of the parent container.

Transformers are able to post-process (transform) the output generated by a Component. That might be XSLT, XQuery or any other processor. Transformers can be implemented as Container or IBehaviour. Both variants redirect the output to a StringResponse which at the end is used as input to the transformer. The output of transformer is than written to the original response.

Core model support for Wicket components.

HTTP implementation.

Test support for the HTTP implementation.

Wicket interface to the JSR-168 portlet API.

This package contains http (web) protocol dependent implementations of request processing strategies.

Java Servlet specific implementation of Wicket http classes.

Package for classes that have generic (protocol independent) support for request cycle processing. Provides the most important request target interfaces and classes.

This package contains a convenience implementation of IRequestCycleProcessor that breaks its functionality in delegate strategies so that they can more easily be mixed and matched. This package also contains a couple of protocol independent default implementations of those strategies.

Common implementations of request targets.

Additions to request targets.

Locale aware resouce loaders.

Several response implementations.

This package contains all the classes to make your wicket components and other pojos @SpringBean annotation aware.

To setup automatic injection of wicket components in your application subclass init() method call: addComponentInstantiationListener(new SpringComponentInjector(this)); To inject any pojo call InjectorHolder.getInjector().inject(this) in the pojo's constructor.

Useful collections.

Contains the classes for concurrency support.

This package provides standardized, efficient versions of utility classes commonly encountered in concurrent Java programming. This code consists of implementations of ideas that have been around for ages, and is merely intended to save you the trouble of coding them. Discussions of the rationale and applications of several of these classes can be found in the second edition of Concurrent Programming in Java. There are also pdf slides providing an overview of the package.

These classes were taken from concurrent.jar, version 1.3.4, provided by Doug Lea. Java 1.5 and later have these collections built in.

Conversion support.

Default converter implementations.

Encryption support for forms.

The {@link org.apache.maven.jrcs.diff diff} package implements the differencing engine that JRCS uses. The engine has the power of Unix diff, is simple to understand, and can be used independently of the archive handling functionality. The entry point to the differencing engine is class {@link org.apache.maven.jrcs.diff.Diff Diff}.

Text is represented as Object[] because the diff engine is capable of handling more than plain ascci. In fact, arrays of any type that implements {@link java.lang.Object#hashCode hashCode()} and {@link java.lang.Object#equals equals()} correctly can be subject to differencing using this library.

Two implementations of the differencing algorithm are provided.

• {@link SimpleDiff Simple Diff} is a verys imple algorithm that is fast and works well with very large input sequences, but that frequently produces result that are subotimal (at times four or more times larger than GNU diff).
• {@link org.apache.commons.jrcs.diff.myers.MyersDiff MyersDiff} is an implementation of Gene Myers differencing algorithm. Myer's algorithm produces optimum results (minimum diffs), but consumes considerably more memory than SimpleDiff, so its not suitable for very large files.

@author Juanco Anez
@version $Id: package.html,v 1.1 2006/03/12 00:24:21 juanca Exp $
@see Diff 
@see org.apache.maven.jrcs.rcs.Archive

The {@link org.apache.maven.jrcs.diff.myers diff.myers} package implements Gene Myers' differencing algorithm.

Myer's algorithm produces optimum results (minimum diffs), but consumes considerably more memory than SimpleDiff, so its not suitable for very large files.

File utilities.

Input/Output utilities. ByteArrayOutputStream, DeferredFileOutputStream, FileCleaner, ThresholdingOutputStream and IOUtils are copied from the Apache Jakarta Commons IO project (version 1.0). They are used by upload functions.

Java utilities.

Listener/ Observer utilities.

Regular Expressions meta pattern support.

Regular Expressions meta pattern parsers.

Base support for resources.

Locators for finding/ loading resources.

String utilities.

Support for String-variable interpolation.

A package with utility classes to ease unit testing of Wicket applications without the need for a servlet container. The only classes required by users to test are WicketTester and FormTester. WicketTester extends MockWebApplication and extends it with convinience methods to start (render) a page and to test (assert) certain conditions.

FormTester is a utility class to make unit testing a HTML form a breeze.

Threading utilities.

Utilities for working with time(s).

Protocol independent upload utilities. Copied from the Apache Jakarta Commons FileUpload project (1.1-dev, HEAD at 21st of august 2005).

Casting utilities.

Modification observers.

This packages provides the default implementation of Wicket's back button support in the form of the ability to record and 'undo' changes to component composition structure, model changes and user specific (such as the current page of pageable lists) changes.