org.zkoss.zkmax.zul

Class GoldenLayout

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zkmax.zul.GoldenLayout

All Implemented Interfaces:

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

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

A docker type layout component. GoldenPanel is the only child that could be added to.

Since:

8.6.0

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

Modifier and Type	Field and Description
static String	REGION_EAST
static String	REGION_NORTH
static String	REGION_SOUTH
static String	REGION_STACK
static String	REGION_WEST
static String	TARGET_ROOT

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
GoldenLayout()

Method Summary

Modifier and Type	Method and Description
void	addPanel(GoldenPanel goldenPanel, GoldenPanel targetGoldenPanel, String region) Adds an GoldenPanel to the region of the specified area GoldenPanel.
void	addPanel(GoldenPanel goldenPanel, int col, int row, String region) Adds an GoldenPanel to the region of the GoldenPanel at the specified location.
void	addPanel(GoldenPanel goldenPanel, String area, String region) Adds an GoldenPanel to the region of the specified area GoldenPanel.
void	addPanelToRoot(GoldenPanel goldenPanel, String region) Adds an GoldenPanel to the region of the GoldenLayout.
void	beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
void	deletePanels(String area) Deletes the GoldenPanels of this name.
String	getAreas() Gets the current areas template as String.
protected List<List<String>>	getAreasMatrix()
Set<String>	getAreasNames()
Integer	getColumnsSize()
String	getOrient()
protected GoldenPanel	getPanel(int col, int row)
protected GoldenPanel	getPanel(String area)
List<GoldenPanel>	getPanels(int col, int row) Get the panels on the specified location.
List<GoldenPanel>	getPanels(String area) Get the GoldenPanels of the specified area name.
Integer	getRowsSize()
boolean	insertBefore(org.zkoss.zk.ui.Component newChild, org.zkoss.zk.ui.Component refChild)
void	movePanel(GoldenPanel goldenPanel, GoldenPanel targetGoldenPanel, String region) Moves an existing goldenpanel child of this goldenlayout to a specific region of an area.
void	movePanel(GoldenPanel goldenPanel, int col, int row, String region) Moves an existing goldenpanel child of this goldenlayout to a specific location by col and row indexes.
void	movePanel(GoldenPanel goldenPanel, String area, String region) Moves an existing goldenpanel child of this goldenlayout to a specific region of an area.
void	movePanelToRoot(GoldenPanel goldenPanel, String region) Moves an GoldenPanel to the region of the GoldenLayout.
void	onChildAdded(org.zkoss.zk.ui.Component child)
void	onCreate(org.zkoss.zk.ui.event.Event evt) Internal use only
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	service(org.zkoss.zk.au.AuRequest request, boolean everError)
void	setAreas(String areas) Sets a matrix-like areas template, supports only on initial rendering.
void	setOrient(String orient) Sets the initial dividing orientation.
protected String	updateInitialMatrix(GoldenPanel dropTarget, String region, String area)

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, getZclass, 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, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, 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

Field Detail

REGION_NORTH

public static final String REGION_NORTH

See Also:

Constant Field Values

REGION_SOUTH

public static final String REGION_SOUTH

See Also:

Constant Field Values

REGION_EAST

public static final String REGION_EAST

See Also:

Constant Field Values

REGION_WEST

public static final String REGION_WEST

See Also:

Constant Field Values

REGION_STACK

public static final String REGION_STACK

See Also:

Constant Field Values

TARGET_ROOT

public static final String TARGET_ROOT

See Also:

Constant Field Values

Constructor Detail

GoldenLayout

public GoldenLayout()

Method Detail

getAreas

public String getAreas()

Gets the current areas template as String.

Returns:

the current areas template as String.

setAreas

public void setAreas(String areas)

Sets a matrix-like areas template, supports only on initial rendering. Notice that areas is only supported for the initial rendering.

Parameters:

areas - the template of the goldenlayout.

getOrient

public String getOrient()

Returns:

the layout dividing orientation.

setOrient

public void setOrient(String orient)

Sets the initial dividing orientation. vertical: divides to rows to layout vertically first horizontal: divides to columns to layout horizontally first

Parameters:

orient - "vertical" or "horizontal"

getAreasNames

public Set<String> getAreasNames()

Returns:

the current used areas template names.

getColumnsSize

public Integer getColumnsSize()

Returns:

the size of columns of the areas.

getRowsSize

public Integer getRowsSize()

Returns:

the size of the rows of the areas.

getPanels

public List<GoldenPanel> getPanels(int col,
                                   int row)

Get the panels on the specified location.

Parameters:

col - the index of column of areas

row - the index of row of areas

Returns:

the GoldenPanels that is on this location. Note that if the index is larger than the maximum index, it will be set to the maximum index.

getPanels

public List<GoldenPanel> getPanels(String area)

Get the GoldenPanels of the specified area name.

Parameters:

area - of the GoldenPanels

Returns:

GoldenPanels that has the specified name.

getPanel

protected GoldenPanel getPanel(int col,
                               int row)

getPanel

protected GoldenPanel getPanel(String area)

deletePanels

public void deletePanels(String area)

Deletes the GoldenPanels of this name.

Parameters:

area - of the panels to delete.

addPanel

public void addPanel(GoldenPanel goldenPanel,
                     int col,
                     int row,
                     String region)

Adds an GoldenPanel to the region of the GoldenPanel at the specified location. col = -1, or row = -1 means add to the region of the whole GoldenLayout. If no GoldenPanel found at the specified location, will append to the specified region of the whole GoldenLayout. If no region specified, or region not found, will append to region east.

Parameters:

goldenPanel - the GoldenPanel that will be added.

col - the index of column of areas

row - the index of row of areas

region - north, south, east, west, stack

addPanel

public void addPanel(GoldenPanel goldenPanel,
                     String area,
                     String region)

Adds an GoldenPanel to the region of the specified area GoldenPanel. If no GoldenPanel found with the specified area argument, will append to the specified region of the whole GoldenLayout. If no region specified, or region not found, will append to region east.

Parameters:

goldenPanel - the GoldenPanel that will be added.

area - the area name that will be moved to.

region - north, south, east, west, stack

addPanel

public void addPanel(GoldenPanel goldenPanel,
                     GoldenPanel targetGoldenPanel,
                     String region)

Adds an GoldenPanel to the region of the specified area GoldenPanel. If no region specified, or region not found, will append to region east.

Parameters:

goldenPanel - the GoldenPanel that will be added.

targetGoldenPanel - the target GoldenPanel to be dropped to.

region - north, south, east, west, stack

addPanelToRoot

public void addPanelToRoot(GoldenPanel goldenPanel,
                           String region)

Adds an GoldenPanel to the region of the GoldenLayout. This adds the GoldenPanel to the specified region of the whole GoldenLayout.

Parameters:

goldenPanel - the GoldenPanel that will be added.

region - north, south, east, west

movePanel

public void movePanel(GoldenPanel goldenPanel,
                      int col,
                      int row,
                      String region)

Moves an existing goldenpanel child of this goldenlayout to a specific location by col and row indexes. If no GoldenPanel found at the specified location, will move to the specified region of the whole GoldenLayout. If no region specified, or region not found, will move to region east.

Parameters:

goldenPanel - the GoldenPanel that will be moved.

col - the col index of the location.

row - the row index of the location.

region - north, south, east, west, stack

movePanel

public void movePanel(GoldenPanel goldenPanel,
                      String area,
                      String region)

Moves an existing goldenpanel child of this goldenlayout to a specific region of an area. If no GoldenPanel found with the specified area argument, will move to the specified region of the whole GoldenLayout. If no region specified, or region not found, will move to region east.

Parameters:

goldenPanel - the GoldenPanel that will be moved.

area - the area name that will be moved to.

region - north, south, east, west, stack

movePanel

public void movePanel(GoldenPanel goldenPanel,
                      GoldenPanel targetGoldenPanel,
                      String region)

Moves an existing goldenpanel child of this goldenlayout to a specific region of an area. If no region specified, or region not found, will move to region east.

Parameters:

goldenPanel - the GoldenPanel that will be moved.

targetGoldenPanel - the target GoldenPanel to be dropped to.

region - north, south, east, west, stack

movePanelToRoot

public void movePanelToRoot(GoldenPanel goldenPanel,
                            String region)

Moves an GoldenPanel to the region of the GoldenLayout. This moves the GoldenPanel to the specified region of the whole GoldenLayout.

Parameters:

goldenPanel -

region -

getAreasMatrix

protected List<List<String>> getAreasMatrix()

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

onChildAdded

public void onChildAdded(org.zkoss.zk.ui.Component child)

Specified by:

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

Overrides:

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

insertBefore

public boolean insertBefore(org.zkoss.zk.ui.Component newChild,
                            org.zkoss.zk.ui.Component refChild)

Specified by:

insertBefore in interface org.zkoss.zk.ui.Component

Overrides:

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

onCreate

public void onCreate(org.zkoss.zk.ui.event.Event evt)

Internal use only

Since:

8.6.0

renderProperties

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

Overrides:

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

Throws:

IOException

service

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

Specified by:

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

Overrides:

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

updateInitialMatrix

protected String updateInitialMatrix(GoldenPanel dropTarget,
                                     String region,
                                     String area)