Module org.apache.wicket.core

Package org.apache.wicket

Interface IQueueRegion

All Known Implementing Classes:

AbstractErrorPage, AbstractFilter, AbstractToolbar, AbstractTree, AccessDeniedPage, AjaxEditableChoiceLabel, AjaxEditableLabel, AjaxEditableMultiLineLabel, AjaxFallbackDefaultDataTable, AjaxFallbackHeadersToolbar, AjaxFallbackOrderByBorder, AjaxLazyLoadPanel, AjaxListPanel, AjaxNavigationToolbar, AjaxPagingNavigator, AjaxTabbedPanel, AjaxWizardButtonBar, ApplicationView, BaseWicketTester.StartComponentInPage, Border, Border.BorderBodyContainer, BorderPanel, BreadCrumbBar, BreadCrumbPanel, BrowserInfoForm, BrowserInfoPage, CheckedFolder, CheckFolder, ChoiceFilter, ClientSideImageMap, ColGroup, ComponentFeedbackPanel, DataTable, DebugBar, DefaultDataTable, DefaultNestedTree, DefaultTableTree, DevUtilsPage, DevUtilsPanel, DummyHomePage, DummyPanelPage, DynamicWizardStep, EmptyPanel, EnhancedPageView, ExceptionErrorPage, ExportToolbar, FeedbackPanel, FencedFeedbackPanel, FilterToolbar, Folder, FormComponentFeedbackBorder, FormComponentFeedbackIndicator, FormComponentPanel, Fragment, GenericPanel, GenericWebPage, GoAndClearFilter, GoFilter, HeadersToolbar, InspectorDebugPanel, InspectorPage, InternalErrorPage, KittenCaptchaPanel, LiveSessionsPage, LocalDateTimeField, MockHomePage, ModalDialog, MultiFileUploadField, NavigationToolbar, NestedTree, Node, NoFilter, NoRecordsToolbar, OrderByBorder, Page, PageExpiredErrorPage, PageStoreDebugPanel, PageStorePage, PageView, PagingNavigator, Palette, Panel, PersistedPanel, PopupCloseLink.ClosePopupPage, RatingPanel, RedirectPage, RequestsPage, SessionSizeDebugPanel, SessionView, SignInPage, SignInPanel, SignOutPage, StandardDebugPanel, StaticContentStep, StyledLinkLabel, Subtree, TabbedPanel, TableTree, TextFilter, TimeField, UploadProgressBar, WebPage, Wizard, WizardButtonBar, WizardStep, ZonedDateTimeField

public interface IQueueRegion

Demarcates components that act as a root can dequeue children. These are usually components with associated markup since the markup is needed to dequeue. It is also important to note that components queued outside of a region cannot be dequeued into it since regions act as roots for the dequeue process because they contain the markup. As such, for example, a component queued in a page cannot be dequeued into a page child that is a panel because a panel is an IQueueRegion.

Author:

igor

Method Summary

Modifier and Type	Method	Description
void	dequeue()	Starts component dequeueing on this IQueueRegion.
IMarkupFragment	getRegionMarkup()	Returns the markup to use for queuing.
DequeueContext	newDequeueContext()	Creates a new DequeueContext that will be used to dequeue children of this region.

Method Details

newDequeueContext

DequeueContext newDequeueContext()

Creates a new DequeueContext that will be used to dequeue children of this region. Usually containers will create a context with their associated markup by getting it via MarkupContainer.getAssociatedMarkup(), but components that do not render markup in a standard way (such as repeaters and borders) may choose to override this method to implement custom behavior for the dequeueing process.

dequeue

void dequeue()

Starts component dequeueing on this IQueueRegion. This is the entry point into the dequeuing process, it creates the DequeueContext and delegates the operation to the MarkupContainer.dequeue(DequeueContext) method which performs the actual dequeueing. The context's markup is retrieved using the MarkupContainer.getAssociatedMarkup().

getRegionMarkup

IMarkupFragment getRegionMarkup()

Returns the markup to use for queuing. Normally, this is the markup of the component implementing this interface.

Returns:

the markup to use for queuing