org.zkoss.zul
Class Rows

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zk.ui.HtmlBasedComponent
          org.zkoss.zul.impl.XulElement
              org.zkoss.zul.Rows

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, Rows, XulElement

public class Rows
extends XulElement
implements Rows

Defines the rows of a grid. Each child of a rows element should be a Row element.

Default getZclass(): z-rows.(since 3.5.0)

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

protected class	Rows.Children
protected class	Rows.ExtraCtrl A utility class to implement AbstractComponent.getExtraCtrl().

Field Summary

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

_zclass, RS_NO_DISPLAY, RS_NO_HEIGHT, RS_NO_WIDTH

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

_visible

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

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

Constructor Summary

Rows()

Method Summary

protected void	afterInsert(Component comp) Callback if a child has been inserted.
protected void	beforeRemove(Component comp) Callback if a child will be removed (not removed yet).
java.lang.Object	clone() Clones the component.
Grid	getGrid() Returns the grid that contains this rows.
Grid	getGridApi() Returns the grid that contains this rows.
int	getGroupCount() Returns the number of groups.
java.util.List	getGroups() Returns a list of all Group.
int	getVisibleBegin() Deprecated. As of release As of release 3.5.1
java.util.Iterator	getVisibleChildrenIterator() Returns an iterator to iterate thru all visible children.
int	getVisibleEnd() Deprecated. As of release As of release 3.5.1
int	getVisibleItemCount() Returns the number of visible descendant Row.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
boolean	hasGroup() Returns whether Group exists.
boolean	insertBefore(Component child, Component refChild) Inserts a child before the reference child.
protected java.util.List	newChildren() Creates and returns the instance for storing child components.
protected java.lang.Object	newExtraCtrl() Used by AbstractComponent.getExtraCtrl() to create a client control.
boolean	removeChild(Component child) If the child is a group, its groupfoot will be removed at the same time.
void	setParent(Component parent) Sets the parent component.

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

getAction, getActionAttrs, getAllOnClickAttrs, getContext, getCtrlKeys, getInnerAttrs, getOuterAttrs, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

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

focus, getAllOnClickAttrs, getDraggable, getDroppable, getHeight, getLeft, getMoldSclass, getRealSclass, getRealStyle, getRealStyleFlags, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, redraw, setClass, setDraggable, setDroppable, setFocus, setHeight, setLeft, setMoldSclass, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

addAnnotation, addAnnotation, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addSharedAnnotationMap, addSharedEventHandlerMap, appendAsapAttr, appendAsapAttr, appendChild, applyProperties, containsVariable, detach, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getCommand, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getMoldURI, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, hasFellow, invalidate, isAsapRequired, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onDrawNewChild, onPageAttached, onPageDetached, onWrongValue, removeAttribute, removeAttribute, removeEventListener, removeForward, removeForward, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setPageBefore, setVariable, setVisible, smartUpdate, smartUpdate, smartUpdate, smartUpdateDeferred, smartUpdateValues, toString, unsetVariable

Methods inherited from class java.lang.Object

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

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, 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, containsVariable, detach, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setVariable, setVisible, unsetVariable

Constructor Detail

Rows

public Rows()

Method Detail

getGrid

public Grid getGrid()

Returns the grid that contains this rows.

It is the same as AbstractComponent.getParent().

getGridApi

public Grid getGridApi()

Returns the grid that contains this rows.

It is the same as AbstractComponent.getParent().

Specified by:

getGridApi in interface Rows

Since:

3.5.2

getGroupCount

public int getGroupCount()

Returns the number of groups.

Specified by:

getGroupCount in interface Rows

Since:

3.5.0

getGroups

public java.util.List getGroups()

Returns a list of all Group.

Specified by:

getGroups in interface Rows

Since:

3.5.0

hasGroup

public boolean hasGroup()

Returns whether Group exists.

Specified by:

hasGroup in interface Rows

Since:

3.5.0

getVisibleItemCount

public int getVisibleItemCount()

Returns the number of visible descendant Row.

Specified by:

getVisibleItemCount in interface Rows

Since:

3.5.1

getVisibleBegin

public int getVisibleBegin()

Deprecated. As of release As of release 3.5.1

getVisibleEnd

public int getVisibleEnd()

Deprecated. As of release As of release 3.5.1

setParent

public void setParent(Component parent)

Description copied from interface: Component

Sets the parent component.

Note: Component.setParent(org.zkoss.zk.ui.Component) always calls back Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and/or Component.removeChild(org.zkoss.zk.ui.Component), while Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.removeChild(org.zkoss.zk.ui.Component) always calls back Component.setParent(org.zkoss.zk.ui.Component), if the parent is changed. Thus, you don't need to override both Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.setParent(org.zkoss.zk.ui.Component), if you want to customize the behavior.

Specified by:

setParent in interface Component

Overrides:

setParent in class AbstractComponent

insertBefore

public boolean insertBefore(Component child,
                            Component refChild)

Description copied from interface: Component

Inserts a child before the reference child.

You could use Component.setParent(org.zkoss.zk.ui.Component) or Component.appendChild(org.zkoss.zk.ui.Component) instead of this method, unless you want to control where to put the child.

Note: Component.setParent(org.zkoss.zk.ui.Component) always calls back Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and/or Component.removeChild(org.zkoss.zk.ui.Component), while Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.removeChild(org.zkoss.zk.ui.Component) always calls back Component.setParent(org.zkoss.zk.ui.Component), if the parent is changed. Thus, you don't need to override both Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.setParent(org.zkoss.zk.ui.Component), if you want to customize the behavior.

Specified by:

insertBefore in interface Component

Overrides:

insertBefore in class AbstractComponent

Parameters:

child - the new child to be inserted.

refChild - the child before which you want the new child being inserted. If null, the new child is append to the end.

Returns:

true if newChild is added successfully or moved; false if it already has the specified child and the order doesn't change.

removeChild

public boolean removeChild(Component child)

If the child is a group, its groupfoot will be removed at the same time.

Specified by:

removeChild in interface Component

Overrides:

removeChild in class AbstractComponent

Returns:

true if child is removed successfully; false if it doesn't have the specified child

afterInsert

protected void afterInsert(Component comp)

Callback if a child has been inserted.

Default: invalidate if it is the paging mold and it affects the view of the active page.

Since:

3.0.5

beforeRemove

protected void beforeRemove(Component comp)

Callback if a child will be removed (not removed yet).

Default: invalidate if it is the paging mold and it affects the view of the active page.

Since:

3.0.5

getVisibleChildrenIterator

public java.util.Iterator getVisibleChildrenIterator()

Returns an iterator to iterate thru all visible children. Unlike getVisibleItemCount(), it handles only the direct children. Component developer only.

Since:

3.5.1

getZclass

public java.lang.String getZclass()

Description copied from class: HtmlBasedComponent

Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

Default: null (the default value depends on element).

HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

Specified by:

getZclass in interface HtmlBasedComponent

Overrides:

getZclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getSclass(), HtmlBasedComponent.getRealSclass()

clone

public java.lang.Object clone()

Description copied from interface: Component

Clones the component. All of its children is cloned. Notice that the cloned component doesn't belong to any page, nor desktop. It doesn't have parent, either.

Specified by:

clone in interface Component

Overrides:

clone in class AbstractComponent

newChildren

protected java.util.List newChildren()

Description copied from class: AbstractComponent

Creates and returns the instance for storing child components.

Default: it instantiates AbstractComponent.Children.

Overrides:

newChildren in class AbstractComponent

newExtraCtrl

protected java.lang.Object newExtraCtrl()

Description copied from class: HtmlBasedComponent

Used by AbstractComponent.getExtraCtrl() to create a client control. It is used only by component developers.

Defaut: creates an instance of HtmlBasedComponent.ExtraCtrl.

Overrides:

newExtraCtrl in class HtmlBasedComponent