org.zkoss.zkmax.zul

Class Portallayout

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zkmax.zul.Portallayout

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Portallayout
extends org.zkoss.zul.impl.XulElement

A portal layout lays out a container which can have multiple columns, and each column may contain one or more panel. Portal layout provides a way to drag-and-drop panel into other portalchildren from the same portal layout.

Available in ZK EE

Use Portallayout need assign width (either present or pixel) on every Portalchildren, or we cannot make sure about layout look.

Events:
onPortalMove.

Default getZclass(): z-portallayout.

Since:

3.5.0

Author:

jumperchen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
Portallayout()

Method Summary

Modifier and Type	Method and Description
void	beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
String	getMaximizedMode() Returns the mode of the maximized panel.
String	getOrient() Returns the orient.
org.zkoss.zul.Panel	getPanel(int col, int row) Returns the specified panel, or null if not available.
int[]	getPosition(org.zkoss.zul.Panel panel) Returns an int array[col, row] that indicates the specified panel located within this portal layout.
String	getZclass()
boolean	isVertical() Returns whether it is a vertical portallayout.
void	onPortalDrop(PortalDropEvent event) Process the onPortalDrop event sent when the portal drop.
void	onPortalMove(PortalMoveEvent event) Process the onPortalMove event sent when the portal being moved.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	service(org.zkoss.zk.au.AuRequest request, boolean everError) Processes an AU request.
void	setMaximizedMode(String mode) Sets the mode of the panel to maximize according to "whole" or "column".
void	setOrient(String orient) Sets the orient.
boolean	setPanel(org.zkoss.zul.Panel panel, int col, int row) Sets the specified panel via the position(col and row).

Methods inherited from class org.zkoss.zul.impl.XulElement

clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

invalidatePartial

Constructor Detail

Portallayout

public Portallayout()

Method Detail

setOrient

public void setOrient(String orient)
               throws org.zkoss.zk.ui.WrongValueException

Sets the orient.

Parameters:

orient - either "horizontal" or "vertical".

Throws:

org.zkoss.zk.ui.WrongValueException

Since:

7.0.0

getOrient

public String getOrient()

Returns the orient.

Default: vertical

Since:

7.0.0

isVertical

public boolean isVertical()

Returns whether it is a vertical portallayout.

Since:

7.0.0

getPanel

public org.zkoss.zul.Panel getPanel(int col,
                                    int row)

Returns the specified panel, or null if not available.

Parameters:

col - which Portalchildren to fetch (starting at 0).

row - which Panel to fetch (starting at 0).

setPanel

public boolean setPanel(org.zkoss.zul.Panel panel,
                        int col,
                        int row)

Sets the specified panel via the position(col and row).

Parameters:

panel - a new panel component

col - which Portalchildren to fetch (starting at 0).

row - which Panel to fetch (starting at 0).

Returns:

If false, the added panel fails.

getPosition

public int[] getPosition(org.zkoss.zul.Panel panel)

Returns an int array[col, row] that indicates the specified panel located within this portal layout. If not found, [-1, -1] is assumed.

setMaximizedMode

public void setMaximizedMode(String mode)

Sets the mode of the panel to maximize according to "whole" or "column". "Whole" is meaning the size related to the portal layout itself. Otherwise, the size is related to portal children, that is called "column".

Default: "column"

Parameters:

mode - the mode which could be one of "whole" and "column".

Since:

5.0.0

getMaximizedMode

public String getMaximizedMode()

Returns the mode of the maximized panel.

Default: "column"

Since:

5.0.0

getZclass

public String getZclass()

Overrides:

getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

onPortalDrop

public void onPortalDrop(PortalDropEvent event)

Process the onPortalDrop event sent when the portal drop.

Default: move the portal

Since:

9.5.1

onPortalMove

public void onPortalMove(PortalMoveEvent event)

Process the onPortalMove event sent when the portal being moved.

Since:

9.5.1

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class org.zkoss.zul.impl.XulElement

Throws:

IOException

beforeChildAdded

public void beforeChildAdded(org.zkoss.zk.ui.Component child,
                             org.zkoss.zk.ui.Component refChild)

Specified by:

beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent

service

public void service(org.zkoss.zk.au.AuRequest request,
                    boolean everError)

Processes an AU request.

Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onPortalMove.

Specified by:

service in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

service in class org.zkoss.zk.ui.HtmlBasedComponent

Since:

5.0.0