org.zkoss.zul
Class Row

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl

Direct Known Subclasses:

Group, Groupfoot

public class Row
extends XulElement

A single row in a Rows element. Each child of the Row element is placed in each successive cell of the grid. The row with the most child elements determines the number of columns in each row.

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

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

protected class

Row.ExtraCtrl A utility class to implement HtmlBasedComponent.getExtraCtrl().

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

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

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Row()

Method Summary

void	beforeChildAdded(Component newChild, Component refChild) Default: does nothing.
void	beforeParentChanged(Component parent) Default: does nothing.
java.lang.Object	clone() Clones the component.
java.lang.String	getAlign() Returns the horizontal alignment of the whole row.
Detail	getDetailChild() Returns the child detail component.
java.lang.Object	getExtraCtrl() Returns the client control for this component.
Grid	getGrid() Returns the grid that contains this row.
Group	getGroup() Returns the group that this row belongs to, or null.
int	getIndex() Returns the index of the specified row.
java.lang.String	getSclass() Returns the style class.
java.lang.String	getSpans() Deprecated. As of release 5.0.0, use Cell instead.
java.lang.String	getValign() Returns the vertical alignment of the whole row.
<T> T	getValue() Returns the value.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
boolean	insertBefore(Component newChild, Component refChild) Inserts a child before the reference child.
boolean	isNowrap() Returns the nowrap.
void	onChildRemoved(Component child) Default: does nothing.
protected void	renderProperties(ContentRenderer renderer) Renders the content of this component, excluding the enclosing tags and children.
void	setAlign(java.lang.String align) Sets the horizontal alignment of the whole row.
void	setHflex(java.lang.String flex) Deprecated. as of release 6.0.0. To control the size of Grid related components, please refer to Grid and Column instead.
void	setNowrap(boolean nowrap) Sets the nowrap.
void	setSpans(java.lang.String spans) Deprecated. As of release 5.0.0, use Cell instead.
void	setValign(java.lang.String valign) Sets the vertical alignment of the whole row.
<T> void	setValue(T value) Sets the value.
boolean	setVisible(boolean visible) Sets whether this component is visible.
void	setWidth(java.lang.String width) Deprecated. as of release 6.0.0. To control the size of Grid related components, please refer to Grid and Column instead.

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

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

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

focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

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

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Constructor Detail

Row

public Row()

Method Detail

getDetailChild

public Detail getDetailChild()

Returns the child detail component.

Since:

3.5.0

getGrid

public Grid getGrid()

Returns the grid that contains this row.

getAlign

public java.lang.String getAlign()

Returns the horizontal alignment of the whole row.

Default: null (system default: left unless CSS specified).

setAlign

public void setAlign(java.lang.String align)

Sets the horizontal alignment of the whole row. Allowed values: right, left, center, justify, char

isNowrap

public boolean isNowrap()

Returns the nowrap.

Default: null (system default: wrap).

setNowrap

public void setNowrap(boolean nowrap)

Sets the nowrap.

getValign

public java.lang.String getValign()

Returns the vertical alignment of the whole row.

Default: null (system default: top).

setValign

public void setValign(java.lang.String valign)

Sets the vertical alignment of the whole row. Allowed values: top, middle, bottom, baseline

setVisible

public boolean setVisible(boolean visible)

Description copied from interface: Component

Sets whether this component is visible.

Specified by:

setVisible in interface Component

Overrides:

setVisible in class AbstractComponent

Returns:

the previous visibility

getValue

public <T> T getValue()

Returns the value.

Default: null.

Note: the value is application dependent, you can place whatever value you want.

setValue

public <T> void setValue(T value)

Sets the value.

Parameters:

value - the value.

Note: the value is application dependent, you can place whatever value you want.

getSpans

public java.lang.String getSpans()

Deprecated. As of release 5.0.0, use Cell instead.

Returns the spans, which is a list of numbers separated by comma.

Default: empty.

setSpans

public void setSpans(java.lang.String spans)
              throws WrongValueException

Deprecated. As of release 5.0.0, use Cell instead.

Sets the spans, which is a list of numbers separated by comma.

For example, "1,2,3" means the second column will span two columns and the following column span three columns, while others occupies one column.

Throws:

WrongValueException

getIndex

public int getIndex()

Returns the index of the specified row.

Notice that the performance is not good if there are a lot of rows. Therefore, this method shall not be used with a huge grid.

Since:

6.0.0

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.

Overrides:

getZclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getSclass()

getGroup

public Group getGroup()

Returns the group that this row belongs to, or null.

Since:

3.5.0

setWidth

public void setWidth(java.lang.String width)

Deprecated. as of release 6.0.0. To control the size of Grid related components, please refer to Grid and Column instead.

Description copied from class: HtmlBasedComponent

Sets the width. If null, the best fit is used.

Overrides:

setWidth in class HtmlBasedComponent

See Also:

HtmlBasedComponent.setWidthDirectly(java.lang.String), AbstractComponent.disableClientUpdate(boolean)

setHflex

public void setHflex(java.lang.String flex)

Deprecated. as of release 6.0.0. To control the size of Grid related components, please refer to Grid and Column instead.

Description copied from class: HtmlBasedComponent

Sets horizontal flex hint of this component.

Number flex indicates how this component's container distributes remaining empty space among its children horizontally. Flexible component grow and shrink to fit their given space. Flexible components with larger flex values will be made larger than components with lower flex values, at the ratio determined by all flexible components. The actual flex value is not relevant unless there are other flexible components within the same container. Once the default sizes of components in a container are calculated, the remaining space in the container is divided among the flexible components, according to their flex ratios.

Specify a flex value of negative value, 0, or "false" has the same effect as leaving the flex attribute out entirely. Specify a flex value of "true" has the same effect as a flex value of 1.

Special flex hint, "min", indicates that the minimum space shall be given to this flexible component to enclose all of its children components. That is, the flexible component grow and shrink to fit its children components.

Overrides:

setHflex in class HtmlBasedComponent

Parameters:

flex - horizontal flex hint of this component.

See Also:

HtmlBasedComponent.setVflex(java.lang.String), HtmlBasedComponent.getHflex()

getSclass

public java.lang.String getSclass()

Returns the style class. By default, it is the same as grid's stye class, unless HtmlBasedComponent.setSclass(java.lang.String) is called with non-empty value.

Overrides:

getSclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getZclass()

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException

Description copied from class: HtmlBasedComponent

Renders the content of this component, excluding the enclosing tags and children.

See also ZK Client-side Reference: Property Rendering

Overrides:

renderProperties in class XulElement

Throws:

java.io.IOException

beforeParentChanged

public void beforeParentChanged(Component parent)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

beforeParentChanged in interface ComponentCtrl

Overrides:

beforeParentChanged in class AbstractComponent

Parameters:

parent - the new parent. If null, it means detachment.

See Also:

ComponentCtrl.beforeParentChanged(org.zkoss.zk.ui.Component)

beforeChildAdded

public void beforeChildAdded(Component newChild,
                             Component refChild)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

beforeChildAdded in interface ComponentCtrl

Overrides:

beforeChildAdded in class AbstractComponent

Parameters:

newChild - the child to be added (never null).

refChild - another child component that the new child will be inserted before it. If null, the new child will be the last child.

See Also:

ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)

insertBefore

public boolean insertBefore(Component newChild,
                            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.

If you would like to monitor if a component is attached or detached from a page, you could register a desktop listener implementing UiLifeCycle.

Specified by:

insertBefore in interface Component

Overrides:

insertBefore in class AbstractComponent

Parameters:

newChild - 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.

onChildRemoved

public void onChildRemoved(Component child)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

onChildRemoved in interface ComponentCtrl

Overrides:

onChildRemoved in class AbstractComponent

See Also:

ComponentCtrl.onChildRemoved(org.zkoss.zk.ui.Component)

clone

public java.lang.Object clone()

Description copied from interface: Component

Clones the component. All of its children and descendants are cloned. Also, ID are preserved.

Specified by:

clone in interface Component

Overrides:

clone in class XulElement

Returns:

the new component. Notice that it doesn't belong to any page, nor desktop. It doesn't have a parent, either.

getExtraCtrl

public java.lang.Object getExtraCtrl()

Description copied from class: HtmlBasedComponent

Returns the client control for this component. It is used only by component developers.

Default: creates an instance of HtmlBasedComponent.ExtraCtrl.

Specified by:

getExtraCtrl in interface ComponentCtrl

Overrides:

getExtraCtrl in class HtmlBasedComponent

Returns:

null if no special handling required. If the component requires some special controls, it could return an object that implements one or several interfaces in the org.zkoss.zk.ui.ext.render package. For example, Cropper.

See Also:

ComponentCtrl.getExtraCtrl()