Class Linelayout

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

    public class Linelayout
    extends org.zkoss.zul.impl.XulElement
    A linelayout component for stylistically displaying chronological information.

    Only works for browsers supporting CSS flexbox (IE11+, Edge, Chrome, Firefox, Safari).

    Default getZclass(): z-linelayout.

    Since:
    9.0.0
    See Also:
    Serialized Form
    • Nested Class Summary

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

        org.zkoss.zk.ui.HtmlBasedComponent.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
      Linelayout()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void beforeChildAdded​(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component insertBefore)  
      int getFirstScale()
      Returns the scale of space occupied by the first area.
      LineitemRenderer<?> getItemRenderer()
      Returns the renderer to render each item, or null if the default renderer is used.
      int getLastScale()
      Returns the scale of space occupied by the last area.
      LineitemRenderer<?> getLineitemRenderer()
      Returns the renderer to render each item, or null if the default renderer is used.
      java.lang.String getLineStyle()
      Returns the CSS style for the line.
      org.zkoss.zul.ListModel<?> getModel()
      Returns the model associated with this linelayout, or null if this linelayout is not associated with any list data model.
      java.lang.String getOrient()
      Returns the orient.
      java.lang.String getZclass()  
      void onInitRender()
      Handles a private event, onInitRender.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void setFirstScale​(int firstScale)
      Sets the scale of space occupied by the first area.
      void setItemRenderer​(LineitemRenderer<?> renderer)
      Sets the renderer which is used to render each item if getModel() is not null.
      void setLastScale​(int lastScale)
      Sets the scale of space occupied by the last area.
      void setLineitemRenderer​(LineitemRenderer renderer)
      Sets the renderer which is used to render each item if getModel() is not null.
      void setLineStyle​(java.lang.String lineStyle)
      Sets the CSS style for the line.
      void setModel​(org.zkoss.zul.ListModel<?> model)
      Sets the list model associated with this linelayout.
      void setOrient​(java.lang.String orient)
      Sets the orient.
      • 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, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, service, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, 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, beforeParentChanged, 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 Detail

      • Linelayout

        public Linelayout()
    • Method Detail

      • getOrient

        public java.lang.String getOrient()
        Returns the orient.

        Default: "vertical".

      • setOrient

        public void setOrient​(java.lang.String orient)
        Sets the orient.
        Parameters:
        orient - either horizontal or vertical
      • getLineStyle

        public java.lang.String getLineStyle()
        Returns the CSS style for the line.
      • setLineStyle

        public void setLineStyle​(java.lang.String lineStyle)
        Sets the CSS style for the line.
        Parameters:
        lineStyle - the CSS style for the line.
      • getFirstScale

        public int getFirstScale()
        Returns the scale of space occupied by the first area.

        Default: 1.

      • setFirstScale

        public void setFirstScale​(int firstScale)
        Sets the scale of space occupied by the first area.
        Parameters:
        firstScale - the scale of space occupied by the first area.
      • getLastScale

        public int getLastScale()
        Returns the scale of space occupied by the last area.

        Default: 1.

      • setLastScale

        public void setLastScale​(int lastScale)
        Sets the scale of space occupied by the last area.
        Parameters:
        lastScale - the scale of space occupied by the last area.
      • beforeChildAdded

        public void beforeChildAdded​(org.zkoss.zk.ui.Component child,
                                     org.zkoss.zk.ui.Component insertBefore)
        Specified by:
        beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent
      • getLineitemRenderer

        public LineitemRenderer<?> getLineitemRenderer()
        Returns the renderer to render each item, or null if the default renderer is used.
      • setLineitemRenderer

        public void setLineitemRenderer​(LineitemRenderer renderer)
        Sets the renderer which is used to render each item if getModel() is not null.
        Parameters:
        renderer - the renderer, or null to use the default.
      • getModel

        public org.zkoss.zul.ListModel<?> getModel()
        Returns the model associated with this linelayout, or null if this linelayout is not associated with any list data model.
      • setModel

        public void setModel​(org.zkoss.zul.ListModel<?> model)
        Sets the list model associated with this linelayout.
        Parameters:
        model - the list model to associate, or null to dissociate any previous model.
      • onInitRender

        public void onInitRender()
        Handles a private event, onInitRender. It is used only for implementation, and you rarely need to invoke it explicitly.
      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                                 throws java.io.IOException
        Overrides:
        renderProperties in class org.zkoss.zul.impl.XulElement
        Throws:
        java.io.IOException
      • getZclass

        public java.lang.String getZclass()
        Overrides:
        getZclass in class org.zkoss.zk.ui.HtmlBasedComponent
      • getItemRenderer

        public LineitemRenderer<?> getItemRenderer()
        Returns the renderer to render each item, or null if the default renderer is used.
      • setItemRenderer

        public void setItemRenderer​(LineitemRenderer<?> renderer)
        Sets the renderer which is used to render each item if getModel() is not null.

        Note: changing a render will cause the linelayout to re-render.

        Parameters:
        renderer - the renderer, or null to use the default.