Class GridBox

  • 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 GridBox
    extends org.zkoss.zul.Div
    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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DATA_ATTRIBUTE  
      static java.lang.String MARK_NAME_SELECT  
      static java.lang.String SCLASS_YW_GRID_VIEW_TILES  
      static java.lang.String YW_SELECTED  
      • 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_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
    • Constructor Summary

      Constructors 
      Constructor Description
      GridBox()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.zkoss.zk.ui.HtmlBasedComponent createBox​(java.lang.Object data)  
      protected void deselectItem​(org.zkoss.zk.ui.HtmlBasedComponent box)  
      protected java.util.Set<java.lang.Object> findSelectionRange​(org.zkoss.zul.ListModelList model, int currentSelectedItem)  
      protected ComponentMarkingUtils getComponentMarkingUtils()  
      java.lang.String getEmptyMessage()  
      int getLastSelectedIndex()  
      org.zkoss.zul.ListModelList getModel()  
      org.zkoss.zk.ui.Component getTile​(java.lang.Object data)
      Returns a tile component for specified data.
      org.zkoss.zul.Div getWrapper()  
      protected void handleBoxClick​(org.zkoss.zk.ui.HtmlBasedComponent box, java.lang.Object data, org.zkoss.zul.ListModelList model, org.zkoss.zk.ui.event.MouseEvent event)  
      protected void handleItemSelection​(org.zkoss.zk.ui.HtmlBasedComponent box, java.lang.Object data, org.zkoss.zul.ListModelList model)  
      protected void handleSelectClick​(org.zkoss.zk.ui.HtmlBasedComponent box, java.lang.Object data, org.zkoss.zul.ListModelList model, java.lang.Object event)  
      protected boolean indexesInRange​(int index0, int index1)  
      protected boolean isAnyElementSelectedOnCurrentPage​(org.zkoss.zul.ListModelList model)  
      boolean isMultiple()  
      protected boolean isSelectionChangeNeeded​(java.util.Set<?> selection, org.zkoss.zk.ui.Component box)  
      boolean isSelectOnClick()  
      protected void markSelectedIfNeeded​(org.zkoss.zk.ui.HtmlBasedComponent box, java.lang.Object element)  
      void refreshView()  
      protected void registerListDataListener​(org.zkoss.zul.ListModelList model)  
      protected void renderBox​(org.zkoss.zk.ui.HtmlBasedComponent box, java.lang.Object element, int i)  
      void selectByData​(java.util.Set<?> selection)  
      void selectByIndex​(int index)  
      protected void selectItem​(org.zkoss.zk.ui.HtmlBasedComponent box, java.lang.Object data)  
      protected void sendFocusEvent​(java.lang.Object focusedItem)  
      protected void sendOnClickEvent​(org.zkoss.zk.ui.Component box)  
      protected void sendSelectEvent​(java.lang.Object data, java.util.Set<java.lang.Object> selectedItems, java.util.Set<java.lang.Object> unselectedItems, int keys)  
      void setEmptyMessage​(java.lang.String emptyMessage)  
      protected void setFocus​(org.zkoss.zk.ui.HtmlBasedComponent box)  
      protected void setFocus​(org.zkoss.zk.ui.HtmlBasedComponent box, java.lang.Object element)  
      void setItemRenderer​(GridBoxItemRenderer renderer)  
      void setModel​(org.zkoss.zul.ListModelList model)  
      void setMultiple​(boolean multiple)  
      void setSelectOnClick​(boolean selectOnClick)  
      • Methods inherited from class org.zkoss.zul.Div

        getAlign, renderProperties, setAlign
      • 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, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, service, setAction, setClass, 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, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, 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, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, 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, setWidgetAttribute, 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

      • GridBox

        public GridBox()
    • Method Detail

      • refreshView

        public void refreshView()
      • markSelectedIfNeeded

        protected void markSelectedIfNeeded​(org.zkoss.zk.ui.HtmlBasedComponent box,
                                            java.lang.Object element)
      • renderBox

        protected void renderBox​(org.zkoss.zk.ui.HtmlBasedComponent box,
                                 java.lang.Object element,
                                 int i)
      • handleBoxClick

        protected void handleBoxClick​(org.zkoss.zk.ui.HtmlBasedComponent box,
                                      java.lang.Object data,
                                      org.zkoss.zul.ListModelList model,
                                      org.zkoss.zk.ui.event.MouseEvent event)
      • handleSelectClick

        protected void handleSelectClick​(org.zkoss.zk.ui.HtmlBasedComponent box,
                                         java.lang.Object data,
                                         org.zkoss.zul.ListModelList model,
                                         java.lang.Object event)
      • isAnyElementSelectedOnCurrentPage

        protected boolean isAnyElementSelectedOnCurrentPage​(org.zkoss.zul.ListModelList model)
      • findSelectionRange

        protected java.util.Set<java.lang.Object> findSelectionRange​(org.zkoss.zul.ListModelList model,
                                                                     int currentSelectedItem)
      • sendSelectEvent

        protected void sendSelectEvent​(java.lang.Object data,
                                       java.util.Set<java.lang.Object> selectedItems,
                                       java.util.Set<java.lang.Object> unselectedItems,
                                       int keys)
      • handleItemSelection

        protected void handleItemSelection​(org.zkoss.zk.ui.HtmlBasedComponent box,
                                           java.lang.Object data,
                                           org.zkoss.zul.ListModelList model)
      • selectItem

        protected void selectItem​(org.zkoss.zk.ui.HtmlBasedComponent box,
                                  java.lang.Object data)
      • setFocus

        protected void setFocus​(org.zkoss.zk.ui.HtmlBasedComponent box,
                                java.lang.Object element)
      • setFocus

        protected void setFocus​(org.zkoss.zk.ui.HtmlBasedComponent box)
      • sendFocusEvent

        protected void sendFocusEvent​(java.lang.Object focusedItem)
      • deselectItem

        protected void deselectItem​(org.zkoss.zk.ui.HtmlBasedComponent box)
      • selectByIndex

        public void selectByIndex​(int index)
      • getTile

        public org.zkoss.zk.ui.Component getTile​(java.lang.Object data)
        Returns a tile component for specified data.
        Parameters:
        data - data for which tile is to be found
        Returns:
        a tile that is bound to specified data
      • selectByData

        public void selectByData​(java.util.Set<?> selection)
      • isSelectionChangeNeeded

        protected boolean isSelectionChangeNeeded​(java.util.Set<?> selection,
                                                  org.zkoss.zk.ui.Component box)
      • sendOnClickEvent

        protected void sendOnClickEvent​(org.zkoss.zk.ui.Component box)
      • createBox

        protected org.zkoss.zk.ui.HtmlBasedComponent createBox​(java.lang.Object data)
      • getModel

        public org.zkoss.zul.ListModelList getModel()
      • setModel

        public void setModel​(org.zkoss.zul.ListModelList model)
      • getEmptyMessage

        public java.lang.String getEmptyMessage()
      • setEmptyMessage

        public void setEmptyMessage​(java.lang.String emptyMessage)
      • registerListDataListener

        protected void registerListDataListener​(org.zkoss.zul.ListModelList model)
      • indexesInRange

        protected boolean indexesInRange​(int index0,
                                         int index1)
      • isMultiple

        public boolean isMultiple()
      • setMultiple

        public void setMultiple​(boolean multiple)
      • getLastSelectedIndex

        public int getLastSelectedIndex()
      • getWrapper

        public org.zkoss.zul.Div getWrapper()
      • isSelectOnClick

        public boolean isSelectOnClick()
      • setSelectOnClick

        public void setSelectOnClick​(boolean selectOnClick)