org.zkoss.zkmax.zul.api
Interface Portallayout

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement
All Known Implementing Classes:
Portallayout

public interface Portallayout
extends 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 Portallayout.getZclass(): z-portal-layout.

Since:
3.5.0
Author:
jumperchen

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 java.lang.String getMaximizedMode()
          Returns the mode of the maximized panel.
 Panel getPanel(int col, int row)
          Returns the specified pnael, or null if not available.
 int[] getPosition(Panel panel)
          Returns an int array[col, row] that indicates the specified panel located within this portal layout.
 void setMaximizedMode(java.lang.String mode)
          Sets the mode of the panel to maximize according to "whole" or "column".
 boolean setPanel(Panel panel, int col, int row)
          Sets the specified panel via the position(col and row).
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

getPanel

Panel getPanel(int col,
               int row)
Returns the specified pnael, or null if not available.

Parameters:
col - which Portalchildren to fetch (starting at 0).
row - which Panel to fetch (starting at 0).

setPanel

boolean setPanel(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

int[] getPosition(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

void setMaximizedMode(java.lang.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

java.lang.String getMaximizedMode()
Returns the mode of the maximized panel.

Default: "mode"

Since:
5.0.0


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo