Package org.zkoss.zkmax.zul

Class Lineitem

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zkmax.zul.Lineitem
All Implemented Interfaces:
Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
public class Lineitem extends org.zkoss.zul.impl.XulElement
A lineitem.

Lineitem is the child of Linelayout, it can contain up to 2 components inside.

Default HtmlBasedComponent.getZclass(): z-lineitem

Since:
9.0.0
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected class 
    Lineitem.ExtraCtrl
     

    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 class org.zkoss.zk.ui.HtmlBasedComponent

    _zclass

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
     
    void
    beforeParentChanged(org.zkoss.zk.ui.Component parent)
     
    String
    getBackSpace()
    Returns the spacing with the next lineitem.
    Object
    getExtraCtrl()
     
    String
    getFrontSpace()
    Returns the spacing with the previous lineitem.
    String
    getPointIconSclass()
    Returns the iconSclass name of this point.
    org.zkoss.image.Image
    getPointImageContent()
    Returns the source content of the point image.
    String
    getPointImageSrc()
    Returns the source URI of the point image.
    String
    getPointStyle()
    Returns the CSS style for the point.
    boolean
    isOpposite()
    Returns whether the first child is displayed in the first area(left/top).
    boolean
    isPointVisible()
    Returns whether the point is visible.
    protected void
    renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
     
    void
    setBackSpace(String backSpace)
    Sets the spacing with the next lineitem.
    void
    setFrontSpace(String frontSpace)
    Sets the spacing with the previous lineitem.
    void
    setOpposite(boolean opposite)
    Sets whether the first child is displayed in the first area(left/top).
    void
    setPointIconSclass(String pointIconSclass)
    Sets the iconSclass name of the point.
    void
    setPointImageContent(RenderedImage image)
    Sets the pointImageContent directly with the rendered image.
    void
    setPointImageContent(org.zkoss.image.Image image)
    Sets the pointImageContent directly.
    void
    setPointImageSrc(String src)
    Sets the source URI of the point image.
    void
    setPointStyle(String pointStyle)
    Sets the pointStyle.
    void
    setPointVisible(boolean pointVisible)
    Sets whether the point is visible.

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

    clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

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

    addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, service, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setSkeleton, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

    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, beforeChildRemoved, 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, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isChildable, 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, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, 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

    • Lineitem

      public Lineitem()

  • Method Details

    • isPointVisible

      public boolean isPointVisible()
      Returns whether the point is visible.

      Default: true.

    • setPointVisible

      public void setPointVisible(boolean pointVisible)
      Sets whether the point is visible.
      Parameters:
      pointVisible - whether the point is visible.

    • getPointStyle

      public String getPointStyle()
      Returns the CSS style for the point.

    • setPointStyle

      public void setPointStyle(String pointStyle)
      Sets the pointStyle.
      Parameters:
      pointStyle - the CSS style for the point.

    • getPointImageSrc

      public String getPointImageSrc()
      Returns the source URI of the point image.

      Default: null.

    • setPointImageSrc

      public void setPointImageSrc(String src)
      Sets the source URI of the point image.

      Calling this method implies setPointImageContent(null). In other words, the last invocation of setPointImageSrc(java.lang.String) overrides the previous setPointImageContent(org.zkoss.image.Image), if any.

      Parameters:
      src - the URI of the image source
      See Also:

    • getPointImageContent

      public org.zkoss.image.Image getPointImageContent()
      Returns the source content of the point image.

      Default: null.

      Since:
      10.0.0

    • setPointImageContent

      public void setPointImageContent(org.zkoss.image.Image image)
      Sets the pointImageContent directly.

      Default: null.

      Calling this method implies setPointImageSrc(null). In other words, the last invocation of setPointImageContent(org.zkoss.image.Image) overrides the previous setPointImageSrc(java.lang.String), if any.

      Parameters:
      image - the image to display.
      See Also:

    • setPointImageContent

      public void setPointImageContent(RenderedImage image)
      Sets the pointImageContent directly with the rendered image. It actually encodes the rendered image to an PNG image (Image) with Images.encode(java.lang.String, java.awt.image.RenderedImage, float, boolean), and then invoke setPointImageContent(org.zkoss.image.Image).

    • getPointIconSclass

      public String getPointIconSclass()
      Returns the iconSclass name of this point.

    • setPointIconSclass

      public void setPointIconSclass(String pointIconSclass)
      Sets the iconSclass name of the point.
      Parameters:
      pointIconSclass - the iconSclass name.

    • isOpposite

      public boolean isOpposite()
      Returns whether the first child is displayed in the first area(left/top).

      Default: false.

    • setOpposite

      public void setOpposite(boolean opposite)
      Sets whether the first child is displayed in the first area(left/top).
      Parameters:
      opposite - whether the first child is displayed in the first area(left/top).

    • getFrontSpace

      public String getFrontSpace()
      Returns the spacing with the previous lineitem.

    • setFrontSpace

      public void setFrontSpace(String frontSpace)
      Sets the spacing with the previous lineitem.
      Parameters:
      frontSpace - the spacing with the previous lineitem. (such as "5px" or "5em"). If null or empty (""), the default spacing is used (i.e., controlled by CSS alone).

    • getBackSpace

      public String getBackSpace()
      Returns the spacing with the next lineitem.

    • setBackSpace

      public void setBackSpace(String backSpace)
      Sets the spacing with the next lineitem.
      Parameters:
      backSpace - the spacing with the next lineitem. (such as "5px" or "5em"). If null or empty (""), the default spacing is used (i.e., controlled by CSS alone).

    • 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

    • beforeChildAdded

      public void beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
      Specified by:
      beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      beforeChildAdded 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.zul.impl.XulElement
      Throws:
      IOException

    • getExtraCtrl

      public Object getExtraCtrl()
      Specified by:
      getExtraCtrl in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      getExtraCtrl in class org.zkoss.zk.ui.HtmlBasedComponent