org.zkoss.zul
Class Area

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zul.Area

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, 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

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

Constructor Summary

Area()

Area(java.lang.String coords)

Method Summary

java.lang.String	getCoords() Returns the coordination of this area.
java.lang.String	getOuterAttrs() Returns the attributes for generating the HTML tag; never return null.
java.lang.String	getShape() Returns the shape of this area.
java.lang.String	getTooltiptext() Returns the text as the tooltip.
void	setCoords(java.lang.String coords) Sets the coords of this area.
void	setId(java.lang.String id)
void	setParent(org.zkoss.zk.ui.Component parent)
void	setShape(java.lang.String shape) Sets the shape of this area.
void	setTooltiptext(java.lang.String tooltiptext) Sets the text as the tooltip.

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

addAnnotation, addAnnotation, addEventHandler, addEventListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, clone, containsVariable, detach, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getEventHandler, getExtraCtrl, getFellow, getFellowIfAny, getId, getListenerIterator, getMold, getMoldURI, getNamespace, getPage, getParent, getPropagatee, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isListenerAvailable, isVisible, newExtraCtrl, onChildAdded, onChildRemoved, onDrawNewChild, onWrongValue, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setComponentDefinition, setMold, setPage, setVariable, setVisible, smartUpdate, smartUpdate, smartUpdate, toString, unsetVariable

Methods inherited from class java.lang.Object

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

Constructor Detail

Area

public Area()

Area

public Area(java.lang.String coords)

Method Detail

getShape

public final java.lang.String getShape()

Returns the shape of this area.

Default: null (means rectangle).

setShape

public final void setShape(java.lang.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", "ploygon", and "poly".

getCoords

public final java.lang.String getCoords()

Returns the coordination of this area.

setCoords

public final void setCoords(java.lang.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 java.lang.String getTooltiptext()

Returns the text as the tooltip.

Default: null.

setTooltiptext

public void setTooltiptext(java.lang.String tooltiptext)

Sets the text as the tooltip.

getOuterAttrs

public java.lang.String getOuterAttrs()

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

Used only by component developers.

setId

public void setId(java.lang.String id)

Specified by:

setId in interface org.zkoss.zk.ui.Component

Overrides:

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

setParent

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

Specified by:

setParent in interface org.zkoss.zk.ui.Component

Overrides:

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