org.zkoss.zul

Class Area

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zul.Area

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Area
extends org.zkoss.zk.ui.AbstractComponent

An area of a Imagemap.

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

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

org.zkoss.zk.ui.AbstractComponent.Children

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

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

Constructors

Constructor and Description
Area()
Area(String coords)

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeParentChanged(org.zkoss.zk.ui.Component parent)
String	getCoords() Returns the coordination of this area.
String	getShape() Returns the shape of this area.
String	getTooltiptext() Returns the text as the tooltip.
protected boolean	isChildable() Default: not childable.
protected void	renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
void	setCoords(String coords) Sets the coords of this area.
void	setShape(String shape) Sets the shape of this area.
void	setTooltiptext(String tooltiptext) Sets the text as the tooltip.

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

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, clone, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getPropertyAccess, getRedrawCallback, getRoot, getShadowRoots, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Constructor Detail

Area

public Area()

Area

public Area(String coords)

Method Detail

getShape

public String getShape()

Returns the shape of this area.

Default: null (means rectangle).

setShape

public void setShape(String shape)
              throws org.zkoss.zk.ui.WrongValueException

Sets the shape of this area.

Throws:

org.zkoss.zk.ui.WrongValueException - if shape is not one of null, "rect", "rectangle", "circle", "circ", "polygon", and "poly".

getCoords

public String getCoords()

Returns the coordination of this area.

setCoords

public void setCoords(String coords)

Sets the coords of this area. Its content depends on getShape():

circle

coords="x,y,r"

polygon

coords="x1,y1,x2,y2,x3,y3..."
The polygon is automatically closed, so it is not necessary to repeat the first coordination.

rectangle

coords="x1,y1,x2,y2"

Note: (0, 0) is the upper-left corner.

getTooltiptext

public String getTooltiptext()

Returns the text as the tooltip.

Default: null.

setTooltiptext

public void setTooltiptext(String tooltiptext)

Sets the text as the tooltip.

isChildable

protected boolean isChildable()

Default: not childable.

Overrides:

isChildable in class org.zkoss.zk.ui.AbstractComponent

beforeParentChanged

public void beforeParentChanged(org.zkoss.zk.ui.Component parent)

Specified by:

beforeParentChanged in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

beforeParentChanged in class org.zkoss.zk.ui.AbstractComponent

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException

Overrides:

renderProperties in class org.zkoss.zk.ui.AbstractComponent

Throws:

IOException