Package org.apache.wicket
The core Wicket package. The key core classes you will need to learn to do basic Wicket programming are:
Application
/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.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.IRequestCycleListener
- If you are working with a persistence framework such as Hibernate or JDO, you may need to implement a request cycle listener in order to open a persistence session at the beginning of a request and close the session at the end of the request.MarkupContainer
- You will need to study MarkupContainer carefully as this class contains all the logic for creating and maintaining component hierarchies.Page
/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.PageParameters
- A simple wrapper for query string parameters.Session
/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.
-
Interface Summary Interface Description IApplicationListener Application
lifecycle listenerIBehaviorInstantiationListener Allows applications to intercept behavior instantiationIComponentAwareEventSink A specialization ofIEventSink
that adds component as an additional parameter to theIComponentAwareEventSink.onEvent(Component, IEvent)
method.IConverterLocator Locates the proper converter instance for a given type.IDetachListener Listens toComponent.detach()
calls.IEventDispatcher Delivers an event to a component.IGenericComponent<T,C extends IGenericComponent<? super T,?>> An interface for allcomponents
with type-safe accessors and mutators for the model and its object.IInitializer Initializes something when application loads.IMarkupIdGenerator Generates markup ids for componentsIMetadataContext<B,R extends IMetadataContext<B,R>> Used to unify all metadata methods across the various objects.IPageFactory A factory class that creates Pages.IPageManagerProvider Provider of anIPageManager
.IPageRendererProvider Interface for Function<RenderPageRequestHandler, PageRenderer>IQueueRegion Demarcates components that act as a root can dequeue children.IRequestCycleProvider Provides instances ofRequestCycle
objectsIRequestListener IResourceFactory A factory which creates resources for a given specification string.ISessionListener Session
listenerIWicketInternalException A marker interface for exceptions which are recommended to be handled by the framework -
Class Summary Class Description Application Base class for all Wicket applications.ApplicationListenerCollection AttributeModifier This class allows a tag attribute of a component to be modified dynamically with a value obtained from a model object.BehaviorInstantiationListenerCollection ClassAttributeModifier An AttributeModifier specialized in managing the CSS class attributeComponent Component serves as the highest level abstract base class for all components.ConverterLocator Implementation ofIConverterLocator
interface, which locates converters for a given type.DefaultExceptionMapper If an exception is thrown when a page is being rendered this mapper will decide which error page to show depending on the exception type andapplication configuration
DefaultMapperContext Wicket's default implementation for the mapper contextDefaultMarkupIdGenerator An implementation of IMarkupIdGenerator that uses the Session to generate sequence numbers for the component markup ids.DefaultPageManagerProvider A provider of aPageManager
managing @link IManageablePage}s with a default chain ofIPageStore
s:RequestPageStore
keeping pages until end of the requestCachingPageStore
caching with an ...InSessionPageStore
keeping the last accessed page in the sessionSerializingPageStore
serializing all pages (so they are available for back-button)AsynchronousPageStore
moving storage of pages to an asynchronous worker thread (enabled by default withStoreSettings.isAsynchronous()
)CryptingPageStore
encrypting all pages (disabled by default inStoreSettings.isEncrypted()
)DiskPageStore
persisting all pages, configured according toStoreSettings
An alternative chain with all pages held in-memory could be:RequestPageStore
keeping pages until end of the requestCachingPageStore
caching with an ...InSessionPageStore
keeping the last accessed page in the sessionSerializingPageStore
serializing all pages (so they are available for back-button)AsynchronousPageStore
moving storage of pages to a worker threadInMemoryPageStore
keeping all pages in memory ...DequeueContext Context for component dequeueing.DequeueContext.Bookmark A bookmark for the DequeueContext stackInitializer Initializer for components in wicket core library.Localizer A utility class that encapsulates all of the localization related functionality in a way that it can be accessed by all areas of the framework in a consistent way.MarkupContainer A MarkupContainer holds a map of child components.MetaDataEntry<T> Class used for holding meta data entries.MetaDataKey<T> Page Abstract base class for pages.PageReference Unique identifier of a page instanceResourceBundles Contains all resource bundles that are registered in the application.Session Holds information about a user session, including some fixed number of most recent pages (and all their nested component information).SessionListenerCollection SharedResources Class which holds shared resources.StyleAttributeModifier An AttributeModifier specialized in managing the CSS style attributeSystemMapper Mapper that encapsulates mappers that are necessary for Wicket to function.SystemMapper.HomePageProvider<C extends Page> SystemMapper.ParentFolderPlaceholderProvider ThreadContext Holds thread local state for Wicket data.UrlResourceReferenceMapper A request mapper that is used to create Url out of UrlResourceReference. -
Enum Summary Enum Description AttributeModifier.MarkerValue Special attribute value markers.ChildToDequeueType DequeueTagAction RuntimeConfigurationType -
Exception Summary Exception Description NonResettingRestartException Causes Wicket to interrupt current request processing and immediately respond with the specified page.RestartResponseAtInterceptPageException Causes Wicket to interrupt current request processing and immediately redirect to an intercept page.RestartResponseException Causes Wicket to interrupt current request processing and immediately respond with the specified page.WicketRuntimeException Generic runtime exception subclass thrown by Wicket.