Class ManageFacetPopup

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

    public class ManageFacetPopup
    extends org.zkoss.zul.Window
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected static class  ManageFacetPopup.FacetSelectionStatus  
      • Nested classes/interfaces inherited from class org.zkoss.zul.Window

        org.zkoss.zul.Window.Mode
      • 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
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void adjustFacets​(java.util.Collection<FacetData> facets)  
      protected void applyFacets()  
      void clearAllFacets​(java.lang.Boolean isDisabledAutoSearch)  
      void close()  
      protected java.util.function.Function<java.util.Collection<FacetData>,​java.lang.Object> getApplyCallback()  
      protected int getFacetCurrentRenderLimit()  
      protected int getFacetRenderIncrementStep()  
      protected int getFacetRenderLimit()  
      protected java.util.List<java.util.Map.Entry<java.lang.String,​java.util.Set<ManageFacetPopup.FacetSelectionStatus>>> getFacetsToRender()  
      protected java.lang.String getLabel​(java.lang.String key)  
      protected java.lang.String getLabel​(java.lang.String key, java.lang.Object[] args)  
      protected java.util.function.Predicate<ManageFacetPopup.FacetSelectionStatus> getListModelPredicate​(java.lang.String query)  
      protected int getMaxNumberOfInlineFacets()  
      protected java.util.Collection<FacetData> getSelectedFacetData()  
      java.util.Map<java.lang.String,​java.util.Set<ManageFacetPopup.FacetSelectionStatus>> getStatus()  
      protected WidgetInstanceManager getWidgetInstanceManager()  
      protected void initializeComponents​(boolean makeVisible)  
      protected void initializeInlineChooser()  
      protected void initializePopupChooser()  
      protected boolean isInlineFacetFilterEnabled()  
      protected boolean isInstant()  
      protected org.zkoss.zul.ListModelList<ManageFacetPopup.FacetSelectionStatus> prepareFilteredFacetListModel​(java.util.function.Predicate<ManageFacetPopup.FacetSelectionStatus> predicate)  
      protected java.lang.String prepareShowAllLabel​(int facetsToRender, int renderedFacets)  
      protected java.lang.String prepareShowMoreLabel​(int facetsToRender, int renderedFacets)  
      protected org.zkoss.zul.Div prepareShowMoreSection​(org.zkoss.zul.Div facetContainer, org.zkoss.zul.Div altContainer, java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)  
      protected boolean removeSelectedFacetValue​(FacetData field, FacetValueData value)  
      protected void renderFacet​(java.lang.String facetCode, java.util.Collection<ManageFacetPopup.FacetSelectionStatus> facetSelectionStatuses, org.zkoss.zul.Div facetsContainer, org.zkoss.zul.Div altContainer, java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2005
      protected void renderFacet​(java.lang.String facetCode, java.util.Collection<ManageFacetPopup.FacetSelectionStatus> facetSelectionStatuses, org.zkoss.zul.Div facetsContainer, org.zkoss.zul.Div showAllContainer, org.zkoss.zul.Div altContainer, java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)  
      protected org.zkoss.zul.Div renderFacets​(java.util.Collection<ManageFacetPopup.FacetSelectionStatus> facetSelectionStatuses, int maxNumberOfFacets)  
      protected void renderFacetsChunk​(org.zkoss.zul.Div facetContainer, org.zkoss.zul.Div showAllContainer, org.zkoss.zul.Div altContainer, java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache, int startIndex, int chunkSize)  
      void reset()  
      protected void setFacetCurrentRenderLimit​(int renderLimit)  
      protected boolean shouldRenderFacet​(java.util.Collection<ManageFacetPopup.FacetSelectionStatus> facetSelectionStatuses)  
      protected void showAlternativeContainer​(org.zkoss.zul.Div facetsContainer, org.zkoss.zul.Div alternativeFacetContainer, java.lang.String facetCode, java.lang.String facetDisplayName, java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2005
      protected void showAlternativeContainer​(org.zkoss.zul.Div facetsContainer, org.zkoss.zul.Div showMoreContainer, org.zkoss.zul.Div alternativeFacetContainer, java.lang.String facetCode, java.lang.String facetDisplayName, java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)  
      protected void showPopup()  
      • Methods inherited from class org.zkoss.zul.Window

        beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getModeType, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onClose, onModal, onPageDetached, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost, setVisible
      • Methods inherited from class org.zkoss.zul.impl.XulElement

        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, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, 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, 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, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, 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, 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
      • Methods inherited from interface org.zkoss.zk.ui.IdSpace

        getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow
      • Methods inherited from interface org.zkoss.zk.ui.ext.Scope

        addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
    • Field Detail

      • DEFAULT_MAX_NUMBER_OF_FACET_VALUES_TO_DISPLAY

        public static final int DEFAULT_MAX_NUMBER_OF_FACET_VALUES_TO_DISPLAY
        See Also:
        Constant Field Values
      • DEFAULT_FACET_RENDER_LIMIT

        public static final int DEFAULT_FACET_RENDER_LIMIT
        See Also:
        Constant Field Values
      • DEFAULT_FACET_RENDER_INCREMENT_STEP

        public static final int DEFAULT_FACET_RENDER_INCREMENT_STEP
        See Also:
        Constant Field Values
      • FACET_WITH_COUNT_PATTERN

        public static final java.lang.String FACET_WITH_COUNT_PATTERN
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_APPLY

        public static final java.lang.String I18N_FACET_SUPPORT_APPLY
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_CLOSE

        public static final java.lang.String I18N_FACET_SUPPORT_CLOSE
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_CLEAR

        public static final java.lang.String I18N_FACET_SUPPORT_CLEAR
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_TYPE

        public static final java.lang.String I18N_FACET_SUPPORT_TYPE
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_VALUE

        public static final java.lang.String I18N_FACET_SUPPORT_VALUE
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_SHOW_ALL_FACET_VALUES

        public static final java.lang.String I18N_FACET_SUPPORT_SHOW_ALL_FACET_VALUES
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_BACK

        public static final java.lang.String I18N_FACET_SUPPORT_BACK
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_SELECTED_NUMBER

        public static final java.lang.String I18N_FACET_SUPPORT_SELECTED_NUMBER
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_LIST_NO_MATCHES_FOR_QUERY

        public static final java.lang.String I18N_FACET_SUPPORT_LIST_NO_MATCHES_FOR_QUERY
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_SHOW_MORE_FACETS

        public static final java.lang.String I18N_FACET_SUPPORT_SHOW_MORE_FACETS
        See Also:
        Constant Field Values
      • I18N_FACET_SUPPORT_SHOW_ALL_FACETS

        public static final java.lang.String I18N_FACET_SUPPORT_SHOW_ALL_FACETS
        See Also:
        Constant Field Values
      • SCLASS_YW_APPLY_LABEL

        public static final java.lang.String SCLASS_YW_APPLY_LABEL
        See Also:
        Constant Field Values
      • SCLASS_YW_CANCEL_LABEL

        public static final java.lang.String SCLASS_YW_CANCEL_LABEL
        See Also:
        Constant Field Values
      • SCLASS_YW_CLEAR_LABEL

        public static final java.lang.String SCLASS_YW_CLEAR_LABEL
        See Also:
        Constant Field Values
      • SCLASS_YW_APPLY_CONTAINER

        public static final java.lang.String SCLASS_YW_APPLY_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_TYPE_CONTAINER

        public static final java.lang.String SCLASS_YW_TYPE_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_VALUE_CONTAINER

        public static final java.lang.String SCLASS_YW_VALUE_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_MAIN_CONTAINER

        public static final java.lang.String SCLASS_YW_FACET_MAIN_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_SELECT_POPUP_CONTAINER

        public static final java.lang.String SCLASS_YW_FACET_SELECT_POPUP_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_LABEL_SELECTED_COUNT

        public static final java.lang.String SCLASS_YW_FACET_LABEL_SELECTED_COUNT
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_VALUE_CONTAINER

        public static final java.lang.String SCLASS_YW_FACET_VALUE_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_CONTAINER

        public static final java.lang.String SCLASS_YW_FACET_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_LABEL_CONTAINER

        public static final java.lang.String SCLASS_YW_FACET_LABEL_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_LABEL_MORE

        public static final java.lang.String SCLASS_YW_FACET_LABEL_MORE
        See Also:
        Constant Field Values
      • SCLASS_YW_BUTTON_SHOW_MORE_FACETS_CONTAINER

        public static final java.lang.String SCLASS_YW_BUTTON_SHOW_MORE_FACETS_CONTAINER
        See Also:
        Constant Field Values
      • SCLASS_YW_BUTTON_SHOW_MORE_FACETS

        public static final java.lang.String SCLASS_YW_BUTTON_SHOW_MORE_FACETS
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_SELECTOR_INPUT

        public static final java.lang.String SCLASS_YW_FACET_SELECTOR_INPUT
        See Also:
        Constant Field Values
      • SCLASS_YW_FACET_LIST

        public static final java.lang.String SCLASS_YW_FACET_LIST
        See Also:
        Constant Field Values
      • MODEL_KEY_FACET_SELECTION_STATUS

        public static final java.lang.String MODEL_KEY_FACET_SELECTION_STATUS
        See Also:
        Constant Field Values
      • MODEL_KEY_FILTER_QUERY_FACET_POPUP

        public static final java.lang.String MODEL_KEY_FILTER_QUERY_FACET_POPUP
        See Also:
        Constant Field Values
      • MODEL_KEY_CURRENT_FACET_RENDER_LIMIT

        public static final java.lang.String MODEL_KEY_CURRENT_FACET_RENDER_LIMIT
        See Also:
        Constant Field Values
      • MODEL_KEY_SHOW_MORE_EVENT_LISTENER

        public static final java.lang.String MODEL_KEY_SHOW_MORE_EVENT_LISTENER
        See Also:
        Constant Field Values
      • MODEL_KEY_SHOW_ALL_EVENT_LISTENER

        public static final java.lang.String MODEL_KEY_SHOW_ALL_EVENT_LISTENER
        See Also:
        Constant Field Values
      • SHOW_MORE_CONTAINER_ID

        public static final java.lang.String SHOW_MORE_CONTAINER_ID
        See Also:
        Constant Field Values
      • SHOW_MORE_BUTTON_ID

        public static final java.lang.String SHOW_MORE_BUTTON_ID
        See Also:
        Constant Field Values
      • SHOW_ALL_BUTTON_ID

        public static final java.lang.String SHOW_ALL_BUTTON_ID
        See Also:
        Constant Field Values
    • Constructor Detail

      • ManageFacetPopup

        public ManageFacetPopup​(WidgetInstanceManager widgetInstanceManager,
                                java.util.function.Function<java.util.Collection<FacetData>,​?> applyCallback)
    • Method Detail

      • initializeComponents

        protected void initializeComponents​(boolean makeVisible)
      • clearAllFacets

        public void clearAllFacets​(java.lang.Boolean isDisabledAutoSearch)
      • initializeInlineChooser

        protected void initializeInlineChooser()
      • prepareShowMoreSection

        protected org.zkoss.zul.Div prepareShowMoreSection​(org.zkoss.zul.Div facetContainer,
                                                           org.zkoss.zul.Div altContainer,
                                                           java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)
      • renderFacetsChunk

        protected void renderFacetsChunk​(org.zkoss.zul.Div facetContainer,
                                         org.zkoss.zul.Div showAllContainer,
                                         org.zkoss.zul.Div altContainer,
                                         java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache,
                                         int startIndex,
                                         int chunkSize)
      • renderFacet

        @Deprecated(since="2005",
                    forRemoval=true)
        protected void renderFacet​(java.lang.String facetCode,
                                   java.util.Collection<ManageFacetPopup.FacetSelectionStatus> facetSelectionStatuses,
                                   org.zkoss.zul.Div facetsContainer,
                                   org.zkoss.zul.Div altContainer,
                                   java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 2005
        See Also:
        renderFacet(String, Collection, Div, Div, Div, Map)
      • renderFacet

        protected void renderFacet​(java.lang.String facetCode,
                                   java.util.Collection<ManageFacetPopup.FacetSelectionStatus> facetSelectionStatuses,
                                   org.zkoss.zul.Div facetsContainer,
                                   org.zkoss.zul.Div showAllContainer,
                                   org.zkoss.zul.Div altContainer,
                                   java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)
      • prepareShowMoreLabel

        protected java.lang.String prepareShowMoreLabel​(int facetsToRender,
                                                        int renderedFacets)
      • prepareShowAllLabel

        protected java.lang.String prepareShowAllLabel​(int facetsToRender,
                                                       int renderedFacets)
      • getFacetRenderLimit

        protected int getFacetRenderLimit()
      • getFacetRenderIncrementStep

        protected int getFacetRenderIncrementStep()
      • getMaxNumberOfInlineFacets

        protected int getMaxNumberOfInlineFacets()
      • getFacetCurrentRenderLimit

        protected int getFacetCurrentRenderLimit()
      • setFacetCurrentRenderLimit

        protected void setFacetCurrentRenderLimit​(int renderLimit)
      • isInstant

        protected boolean isInstant()
      • showAlternativeContainer

        @Deprecated(since="2005",
                    forRemoval=true)
        protected void showAlternativeContainer​(org.zkoss.zul.Div facetsContainer,
                                                org.zkoss.zul.Div alternativeFacetContainer,
                                                java.lang.String facetCode,
                                                java.lang.String facetDisplayName,
                                                java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 2005
        See Also:
        showAlternativeContainer(Div, Div, Div, String, String, Map)
      • showAlternativeContainer

        protected void showAlternativeContainer​(org.zkoss.zul.Div facetsContainer,
                                                org.zkoss.zul.Div showMoreContainer,
                                                org.zkoss.zul.Div alternativeFacetContainer,
                                                java.lang.String facetCode,
                                                java.lang.String facetDisplayName,
                                                java.util.Map<java.lang.String,​org.zkoss.zk.ui.Component> detailsComponentCache)
      • initializePopupChooser

        protected void initializePopupChooser()
      • isInlineFacetFilterEnabled

        protected boolean isInlineFacetFilterEnabled()
      • applyFacets

        protected void applyFacets()
      • getSelectedFacetData

        protected java.util.Collection<FacetData> getSelectedFacetData()
      • getLabel

        protected java.lang.String getLabel​(java.lang.String key)
      • getLabel

        protected java.lang.String getLabel​(java.lang.String key,
                                            java.lang.Object[] args)
      • showPopup

        protected void showPopup()
      • reset

        public void reset()
      • close

        public void close()
      • adjustFacets

        public void adjustFacets​(java.util.Collection<FacetData> facets)
      • removeSelectedFacetValue

        protected boolean removeSelectedFacetValue​(FacetData field,
                                                   FacetValueData value)
      • getApplyCallback

        protected java.util.function.Function<java.util.Collection<FacetData>,​java.lang.Object> getApplyCallback()