org.zkoss.zul
Class Panel.ExtraCtrl

java.lang.Object
  org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
      org.zkoss.zul.Panel.ExtraCtrl

All Implemented Interfaces:

Maximizable, Minimizable, Movable, Openable, Sizable, Updatable, ZIndexed, Floating, MultiBranch, PrologAllowed

Enclosing class:

Panel

protected class Panel.ExtraCtrl
extends HtmlBasedComponent.ExtraCtrl
implements MultiBranch, Openable, Floating, Maximizable, Minimizable, Updatable

A utility class to implement AbstractComponent.getExtraCtrl(). It is used only by component developers.

Constructor Summary

protected

Panel.ExtraCtrl()

Method Summary

boolean	inDifferentBranch(Component child) Whether the specified child is placed in different branch of the DOM tree (other than the main one).
boolean	isFloating() Returns whether the component is floating, aka., absolute position.
void	setMaximizedByClient(boolean maximized) Sets the maximized of the component, caused by user's activity at the client.
void	setMinimizedByClient(boolean minimized) Sets the minimized of the component, caused by user's activity at the client.
void	setOpenByClient(boolean open) Sets the open state caused by client's operation.
void	setResult(java.lang.Object result) Sets the result when it is updated from the client successfully.

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

setHeightByClient, setLeftByClient, setPrologContent, setTopByClient, setWidthByClient, setZIndexByClient

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zkoss.zk.ui.ext.client.Sizable

setHeightByClient, setWidthByClient

Methods inherited from interface org.zkoss.zk.ui.ext.client.Movable

setLeftByClient, setTopByClient

Constructor Detail

Panel.ExtraCtrl

protected Panel.ExtraCtrl()

Method Detail

inDifferentBranch

public boolean inDifferentBranch(Component child)

Description copied from interface: MultiBranch

Whether the specified child is placed in different branch of the DOM tree (other than the main one). For example, you might put caption at a branch and the rest at another branch. Then, you shall return false for the caption. Thus, ZK knows how to render them correctly.

Note: for components, say caption, in different branch, you have to invalidate the parent when they are added or removed. Only children causing this method to return true are handled by ZK Update Engine.

Specified by:

inDifferentBranch in interface MultiBranch

setOpenByClient

public void setOpenByClient(boolean open)

Description copied from interface: Openable

Sets the open state caused by client's operation.

This method is designed to be used by engine. Don't invoke it directly. Otherwise, the client and server might mismatch.

Specified by:

setOpenByClient in interface Openable

isFloating

public boolean isFloating()

Description copied from interface: Floating

Returns whether the component is floating, aka., absolute position.

Specified by:

isFloating in interface Floating

setMaximizedByClient

public void setMaximizedByClient(boolean maximized)

Description copied from interface: Maximizable

Sets the maximized of the component, caused by user's activity at the client.

This method is designed to be used by engine. Don't invoke it directly. Otherwise, the client and server might mismatch.

Specified by:

setMaximizedByClient in interface Maximizable

setMinimizedByClient

public void setMinimizedByClient(boolean minimized)

Description copied from interface: Minimizable

Sets the minimized of the component, caused by user's activity at the client.

This method is designed to be used by engine. Don't invoke it directly. Otherwise, the client and server might mismatch.

Specified by:

setMinimizedByClient in interface Minimizable

setResult

public void setResult(java.lang.Object result)

Description copied from interface: Updatable

Sets the result when it is updated from the client successfully.

Specified by:

setResult in interface Updatable