org.zkoss.zkex.zul
Class Fisheyebar

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

All Implemented Interfaces:

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

public class Fisheyebar
extends XulElement
implements Fisheyebar

A fisheye bar is a bar of Fisheye that is a menu similar to the fish eye menu on the Mac OS.

Default getZclass(): z-fisheyebar.

Since:

3.5.0

Author:

jumperchen

See Also:

Serialized Form

Nested Class Summary

protected class

Fisheyebar.ExtraCtrl A utility class to implement AbstractComponent.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, 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

Fisheyebar()

Method Summary

void	beforeChildAdded(Component child, Component refChild) Default: does nothing.
java.lang.String	getAttachEdge() Returns the attach edge.
int	getItemHeight() Returns the item height of Fisheye.
int	getItemMaxHeight() Returns the item maximal height of Fisheye.
int	getItemMaxWidth() Returns the item maximal width of Fisheye.
int	getItemPadding() Returns the item padding of Fisheye.
int	getItemWidth() Returns the item width of Fisheye.
java.lang.String	getLabelEdge() Returns the label edge.
java.lang.String	getOrient() Returns the orientation of Fisheye.
java.lang.String	getOuterAttrs() Returns the exterior attributes for generating the enclosing HTML tag; never return null.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
protected java.lang.Object	newExtraCtrl() Used by AbstractComponent.getExtraCtrl() to create a client control.
void	onChildAdded(Component child) Default: does nothing.
void	onChildRemoved(Component child) Default: does nothing.
void	setAttachEdge(java.lang.String attachEdge) Returns the attach edge.
void	setItemHeight(int itemhgh) Sets the item height of Fisheye.
void	setItemMaxHeight(int itemmaxhgh) Sets the item maximal height of Fisheye.
void	setItemMaxWidth(int itemmaxwd) Sets the item maximal width of Fisheye.
void	setItemPadding(int itemPadding) Sets the item padding of Fisheye.
void	setItemWidth(int itemwd) Sets the item width of Fisheye.
void	setLabelEdge(java.lang.String labelEdge) Returns the label edge.
void	setOrient(java.lang.String orient) Sets the orientation of Fisheye.

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

getAction, getActionAttrs, getAllOnClickAttrs, getContext, getCtrlKeys, getInnerAttrs, 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, beforeChildRemoved, beforeParentChanged, clone, containsVariable, detach, disableClientUpdate, 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, insertBefore, invalidate, isAsapRequired, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onDrawNewChild, onPageAttached, onPageDetached, onWrongValue, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setId, setMold, setPage, setPageBefore, setParent, 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, clone, 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, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Constructor Detail

Fisheyebar

public Fisheyebar()

Method Detail

getItemWidth

public int getItemWidth()

Returns the item width of Fisheye.

Specified by:

getItemWidth in interface Fisheyebar

setItemWidth

public void setItemWidth(int itemwd)
                  throws WrongValueException

Sets the item width of Fisheye.

Specified by:

setItemWidth in interface Fisheyebar

Throws:

WrongValueException

getItemHeight

public int getItemHeight()

Returns the item height of Fisheye.

Specified by:

getItemHeight in interface Fisheyebar

setItemHeight

public void setItemHeight(int itemhgh)
                   throws WrongValueException

Sets the item height of Fisheye.

Specified by:

setItemHeight in interface Fisheyebar

Throws:

WrongValueException

getItemMaxWidth

public int getItemMaxWidth()

Returns the item maximal width of Fisheye.

Specified by:

getItemMaxWidth in interface Fisheyebar

setItemMaxWidth

public void setItemMaxWidth(int itemmaxwd)
                     throws WrongValueException

Sets the item maximal width of Fisheye.

Specified by:

setItemMaxWidth in interface Fisheyebar

Throws:

WrongValueException

getItemMaxHeight

public int getItemMaxHeight()

Returns the item maximal height of Fisheye.

Specified by:

getItemMaxHeight in interface Fisheyebar

setItemMaxHeight

public void setItemMaxHeight(int itemmaxhgh)
                      throws WrongValueException

Sets the item maximal height of Fisheye.

Specified by:

setItemMaxHeight in interface Fisheyebar

Throws:

WrongValueException

getItemPadding

public int getItemPadding()

Returns the item padding of Fisheye.

Specified by:

getItemPadding in interface Fisheyebar

setItemPadding

public void setItemPadding(int itemPadding)
                    throws WrongValueException

Sets the item padding of Fisheye.

Specified by:

setItemPadding in interface Fisheyebar

Throws:

WrongValueException

getOrient

public java.lang.String getOrient()

Returns the orientation of Fisheye.

Specified by:

getOrient in interface Fisheyebar

setOrient

public void setOrient(java.lang.String orient)
               throws WrongValueException

Sets the orientation of Fisheye.

Specified by:

setOrient in interface Fisheyebar

Throws:

WrongValueException

getAttachEdge

public java.lang.String getAttachEdge()

Returns the attach edge.

Default: center

Specified by:

getAttachEdge in interface Fisheyebar

setAttachEdge

public void setAttachEdge(java.lang.String attachEdge)
                   throws WrongValueException

Returns the attach edge.

Specified by:

setAttachEdge in interface Fisheyebar

Throws:

WrongValueException

getLabelEdge

public java.lang.String getLabelEdge()

Returns the label edge.

Default: bottom

Specified by:

getLabelEdge in interface Fisheyebar

setLabelEdge

public void setLabelEdge(java.lang.String labelEdge)
                  throws WrongValueException

Returns the label edge.

Specified by:

setLabelEdge in interface Fisheyebar

Throws:

WrongValueException

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

getOuterAttrs

public java.lang.String getOuterAttrs()

Description copied from class: HtmlBasedComponent

Returns the exterior attributes for generating the enclosing HTML tag; never return null.

Used only by component developers.

Default: Generates the tooltip text, style, sclass, draggable and droppable attribute if necessary. In other words, the corresponding attribute is generated if HtmlBasedComponent.getTooltiptext(), HtmlBasedComponent.getRealStyle(), HtmlBasedComponent.getSclass(), HtmlBasedComponent.getDraggable(), HtmlBasedComponent.getDroppable() are defined.

You have to call both HtmlBasedComponent.getOuterAttrs() and HtmlBasedComponent.getInnerAttrs() to generate complete attributes.

For simple components that all attributes are put on the outest HTML element, all you need is as follows.

<xx id="${self.uuid}"${self.outerAttrs}${self.innerAttrs}>

If you want to put attributes in a nested HTML element, you shall use the following pattern. Notice: if HtmlBasedComponent.getInnerAttrs() in a different tag, the tag must be named with "${self.uuid}!real".

<xx id="${self.uuid}"${self.outerAttrs}>
 <yy id="${self.uuid}!real"${self.innerAttrs}>...

Note: This class handles non-deferrable event listeners automatically. However, you have to invoke AbstractComponent.appendAsapAttr(java.lang.StringBuffer, java.lang.String) for each event the component handles in HtmlBasedComponent.getOuterAttrs() as follows.

        appendAsapAttr(sb, Events.ON_OPEN);
  appendAsapAttr(sb, Events.ON_CHANGE);

Theorectically, you could put any attributes in either HtmlBasedComponent.getInnerAttrs() or HtmlBasedComponent.getOuterAttrs(). However, zkau.js assumes all attributes are put at the outer one. If you want something different, you have to provide your own setAttr (refer to how checkbox is implemented).

Overrides:

getOuterAttrs in class XulElement

onChildAdded

public void onChildAdded(Component child)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

onChildAdded in interface ComponentCtrl

Overrides:

onChildAdded in class AbstractComponent

See Also:

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

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)

beforeChildAdded

public void beforeChildAdded(Component child,
                             Component refChild)

Description copied from class: AbstractComponent

Default: does nothing.

Specified by:

beforeChildAdded in interface ComponentCtrl

Overrides:

beforeChildAdded in class AbstractComponent

Parameters:

child - 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)

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