com.googlecode.wicket.kendo.ui.widget.splitter

Class BorderLayout

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.googlecode.wicket.kendo.ui.widget.splitter.BorderLayout

All Implemented Interfaces:

IBorderLayout, ISplitterListener, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class BorderLayout
extends org.apache.wicket.markup.html.WebMarkupContainer
implements IBorderLayout, ISplitterListener

Provides a Border Layout WebMarkupContainer based on vertical and horizontal SplitterBehaviors
getVerticalPanes() and getHorizontalPanes() may be overridden to change the default layout

Note: the BorderLayout IS a WebMarkupContainer. If you wish to apply a BorderLayout on an existing Page or an existing Panel, consider implementing the IBorderLayout interface.

Alternatively, the HTML markup look like:

 <div wicket:id="layout">
        <div id="vertical">
                <div id="top">
                        <br/>
                </div>
                <div id="horizontal">
                        <div id="left">
                                <br/>
                        </div>
                        <div id="center">
                                <br/>
                        </div>
                        <div id="right">
                                <br/>
                        </div>
                </div>
                <div id="bottom">
                        <br/>
                </div>
        </div>
 </div>
 

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
BorderLayout(String id) Constructor

Method Summary

Modifier and Type	Method and Description
void	addBorderLayout(org.apache.wicket.MarkupContainer container) Method that is designed to create the BorderLayout. A typical implementation is:
void	collapse(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, String selector, String pane) Collapses the specified pane Note: Invoking the method will not trigger a collapse event.
void	expand(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, String selector, String pane) Expands the specified pane Note: Invoking the method will not trigger an expand event.
String	getHorizontalPanes() Gets horizontal panes in a JSON array
String	getVerticalPanes() Gets vertical panes in a JSON array
boolean	isCollapseEventEnabled() Indicates whether the 'collapse' event is enabled. If true, the ISplitterListener.onCollapse(AjaxRequestTarget, String) event will be triggered.
boolean	isExpandEventEnabled() Indicates whether the 'expand' event is enabled. If true, the ISplitterListener.onExpand(AjaxRequestTarget, String) event will be triggered.
protected SplitterBehavior	newHorizontalSplitterBehavior(String selector, String panes) Gets a new horizontal SplitterBehavior
protected SplitterBehavior	newVerticalSplitterBehavior(String selector, String panes) Gets a new vertical SplitterBehavior
void	onCollapse(org.apache.wicket.ajax.AjaxRequestTarget target, String paneId) Triggered when a panel collapses
void	onExpand(org.apache.wicket.ajax.AjaxRequestTarget target, String paneId) Triggered when a panel expands
protected void	onInitialize()

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onDetach, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BorderLayout

public BorderLayout(String id)

Constructor

Parameters:

id - the markup id

Method Detail

isExpandEventEnabled

public boolean isExpandEventEnabled()

Description copied from interface: ISplitterListener

Indicates whether the 'expand' event is enabled.
If true, the ISplitterListener.onExpand(AjaxRequestTarget, String) event will be triggered.

Specified by:

isExpandEventEnabled in interface ISplitterListener

Returns:

false by default

isCollapseEventEnabled

public boolean isCollapseEventEnabled()

Description copied from interface: ISplitterListener

Indicates whether the 'collapse' event is enabled.
If true, the ISplitterListener.onCollapse(AjaxRequestTarget, String) event will be triggered.

Specified by:

isCollapseEventEnabled in interface ISplitterListener

Returns:

false by default

addBorderLayout

public void addBorderLayout(org.apache.wicket.MarkupContainer container)

Description copied from interface: IBorderLayout

Method that is designed to create the BorderLayout.
A typical implementation is:

 container.add(new SplitterBehavior("#vertical").setOption("panes", this.getVerticalPanes()).setOption("orientation", "'vertical'"));
 container.add(new SplitterBehavior("#horizontal").setOption("panes", this.getHorizontalPanes()));
 

Specified by:

addBorderLayout in interface IBorderLayout

Parameters:

container - either a Page or a Panel.

expand

public void expand(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                   String selector,
                   String pane)

Expands the specified pane
Note: Invoking the method will not trigger an expand event.

Parameters:

handler - the IPartialPageRequestHandler

selector - the splitter selector (ie: "#vertical")

pane - the pane selector (ie: "#bottom")

collapse

public void collapse(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                     String selector,
                     String pane)

Collapses the specified pane
Note: Invoking the method will not trigger a collapse event.

Parameters:

handler - the IPartialPageRequestHandler

selector - the splitter selector (ie: "#vertical")

pane - the pane selector (ie: "#bottom")

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.MarkupContainer

onExpand

public void onExpand(org.apache.wicket.ajax.AjaxRequestTarget target,
                     String paneId)

Description copied from interface: ISplitterListener

Triggered when a panel expands

Specified by:

onExpand in interface ISplitterListener

Parameters:

target - the AjaxRequestTarget

paneId - the panel id (html-id)

onCollapse

public void onCollapse(org.apache.wicket.ajax.AjaxRequestTarget target,
                       String paneId)

Description copied from interface: ISplitterListener

Triggered when a panel collapses

Specified by:

onCollapse in interface ISplitterListener

Parameters:

target - the AjaxRequestTarget

paneId - the panel id (html-id)

getVerticalPanes

public String getVerticalPanes()

Gets vertical panes in a JSON array

Specified by:

getVerticalPanes in interface IBorderLayout

Returns:

by default: 15% - middle - 15%

getHorizontalPanes

public String getHorizontalPanes()

Gets horizontal panes in a JSON array

Specified by:

getHorizontalPanes in interface IBorderLayout

Returns:

by default: 15% - center - 15%

newVerticalSplitterBehavior

protected SplitterBehavior newVerticalSplitterBehavior(String selector,
                                                       String panes)

Gets a new vertical SplitterBehavior

Parameters:

selector - the splitter's html selector (ie: "#myId")

panes - the vertical panes in a JSON array

Returns:

a new vertical SplitterBehavior

newHorizontalSplitterBehavior

protected SplitterBehavior newHorizontalSplitterBehavior(String selector,
                                                         String panes)

Gets a new horizontal SplitterBehavior

Parameters:

selector - the splitter's html selector (ie: "#myId")

panes - the horizontal panes in a JSON array

Returns:

a new horizontal SplitterBehavior