Package 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:

  • Nested Class Summary

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

    org.zkoss.zk.ui.AbstractComponent.Children, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

  • 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

    AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_CLONED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

  • Constructor Summary

    Constructors
    Constructor
    Description
    Area()
     
    Area(String coords)
     

  • Method Summary

    Modifier and Type
    Method
    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.
    Integer
    getTabindexInteger()
    Returns null if not set.
    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
    setTabindex(Integer tabindex)
    Sets the tab order of this component.
    void
    setTooltiptext(String tooltiptext)
    Sets the text as the tooltip.

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

    addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, clone, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getPropertyAccess, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getStubonlyDescendants, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onParentChanged, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, replace, response, response, response, service, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setStubonlyDescendants, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, 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

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

  • Constructor Details

    • Area

      public Area()

    • Area

      public Area(String coords)

  • Method Details

    • 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".

    • getTabindexInteger

      public Integer getTabindexInteger()
      Returns null if not set.
      Returns:
      the tab order of this component
      Since:
      8.0.2

    • setTabindex

      public void setTabindex(Integer tabindex)
      Sets the tab order of this component. Removes the tabindex attribute if it's set to null.
      Parameters:
      tabindex -

    • 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