Package org.zkoss.zul

Class Splitter

  • 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 Splitter
extends XulElement
    Deprecated.
    As of release 10.3.0, using org.zkoss.zkmax.zul.Splitlayout instead.
    An element which should appear before or after an element inside a box (Box, Vbox and Hbox).

    When the splitter is dragged, the sibling elements of the splitter are resized. If getCollapse() is true, a grippy is placed inside the splitter, and one sibling element of the splitter is collapsed when the grippy is clicked.

    Events: onOpen

    Default getZclass(): z-splitter.

    Author:
    tomyeh
    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
      Splitter()
      Deprecated.
       

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void beforeParentChanged​(org.zkoss.zk.ui.Component parent)
      Deprecated.
       
      java.lang.String getCollapse()
      Deprecated.
      Returns which side of the splitter is collapsed when its grippy is clicked.
      java.lang.String getOrient()
      Deprecated.
      Returns the orientation of the splitter.
      java.lang.String getZclass()
      Deprecated.
       
      protected boolean isChildable()
      Deprecated.
      Not allow any children.
      boolean isHorizontal()
      Deprecated.
      Returns if the orientation of this splitter is horizontal.
      boolean isOpen()
      Deprecated.
      Returns whether it is open (i.e., not collapsed.
      boolean isVertical()
      Deprecated.
      Returns if the orientation of this splitter is vertical.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
      Deprecated.
       
      void service​(org.zkoss.zk.au.AuRequest request, boolean everError)
      Deprecated.
      Processes an AU request.
      void setCollapse​(java.lang.String collapse)
      Deprecated.
      Sets which side of the splitter is collapsed when its grippy is clicked.
      void setOpen​(boolean open)
      Deprecated.
      Opens or collapses the splitter.

      • 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, 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, beforeChildAdded, 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, 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

      • Splitter

        public Splitter()
        Deprecated.

    • Method Detail

      • isVertical

        public boolean isVertical()
        Deprecated.
        Returns if the orientation of this splitter is vertical.
        Since:
        5.0.0

      • isHorizontal

        public boolean isHorizontal()
        Deprecated.
        Returns if the orientation of this splitter is horizontal.
        Since:
        5.0.0

      • getOrient

        public java.lang.String getOrient()
        Deprecated.
        Returns the orientation of the splitter. It is the same as the parent's orientation (Box.getOrient().

      • getCollapse

        public java.lang.String getCollapse()
        Deprecated.
        Returns which side of the splitter is collapsed when its grippy is clicked. If this attribute is not specified, the splitter will not cause a collapse. If it is collapsed, isOpen() returns false.

        Default: none.

        The returned value can be one of the following.

        none
        No collapsing occurs.
        before
        When the grippy is clicked, the element immediately before the splitter in the same parent is collapsed so that its width or height is 0.
        after
        When the grippy is clicked, the element immediately after the splitter in the same parent is collapsed so that its width or height is 0.

        Unlike XUL, you don't have to put a so-called grippy component as a child of the splitter.

      • setCollapse

        public void setCollapse​(java.lang.String collapse)
                 throws org.zkoss.zk.ui.WrongValueException
        Deprecated.
        Sets which side of the splitter is collapsed when its grippy is clicked. If this attribute is not specified, the splitter will not cause a collapse.
        Parameters:
        collapse - one of none, before and after. If null or empty is specified, none is assumed.
        Throws:
        org.zkoss.zk.ui.WrongValueException
        See Also:
        getCollapse()

      • isOpen

        public boolean isOpen()
        Deprecated.
        Returns whether it is open (i.e., not collapsed. Meaningful only if getCollapse() is not "none".

      • setOpen

        public void setOpen​(boolean open)
        Deprecated.
        Opens or collapses the splitter. Meaningful only if getCollapse() is not "none".

      • beforeParentChanged

        public void beforeParentChanged​(org.zkoss.zk.ui.Component parent)
        Deprecated.
        Specified by:
        beforeParentChanged in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        beforeParentChanged in class org.zkoss.zk.ui.AbstractComponent

      • isChildable

        protected boolean isChildable()
        Deprecated.
        Not allow any children.
        Overrides:
        isChildable in class org.zkoss.zk.ui.AbstractComponent

      • renderProperties

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

      • getZclass

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

      • service

        public void service​(org.zkoss.zk.au.AuRequest request,
                    boolean everError)
        Deprecated.
        Processes an AU request.

        Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onOpen.

        Specified by:
        service in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        service in class org.zkoss.zk.ui.HtmlBasedComponent
        Since:
        5.0.0