Class AdvancedSearchView

    • 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
      protected static java.lang.String CLEAR_BTN_IMG  
      protected static java.lang.String EDIT_BTN_IMG  
      protected static java.lang.String EDIT_BTN_IMG_ACTIVE  
      protected boolean initialized  
      protected static java.lang.String SEARCH_MAGNIFIER_BTN_IMG  
      • 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
      AdvancedSearchView()  
      AdvancedSearchView​(java.util.List<? extends org.zkoss.zk.ui.Component> leftButtons, java.util.List<? extends org.zkoss.zk.ui.Component> rightButtons)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.zkoss.zk.ui.Component createEditSearchFieldEntry​(SearchField field)  
      protected EditSearchGroupComponent createEditSearchGroupComponent​(SearchFieldGroup group)  
      protected org.zkoss.zk.ui.Component createSearchFieldRowComponent​(SearchField field)  
      protected SearchGroupComponent createSearchGroupComponent​(SearchFieldGroup group)  
      protected void createSimpleRowComponent​(org.zkoss.zk.ui.Component parent, java.lang.Object rawInitialValue, PropertyDescriptor propertyDescriptor, SearchField field, UIEditor editor)  
      protected void fireActionPerformed​(java.lang.String actionCode, SearchField field)  
      AdvancedSearchModel getModel()
      Returns this view component's model.
      AdvancedSearchParameterContainer getParameterContainer()  
      boolean initialize()
      Initializes this view component.
      protected void renderEditArea​(org.zkoss.zk.ui.Component parent)  
      protected void renderEditSearchFieldEntries​(java.util.Collection<SearchField> entries, org.zkoss.zk.ui.Component parent)  
      protected void resizeCorrespondingContentBrowser()  
      void setEditMode​(boolean value)  
      void setModel​(AdvancedSearchModel model)
      Sets the model of this view component to model and initializes the view (if model is not null).
      boolean update()
      Updates this view component completely.
      void updateSearchField​(SearchField searchField, java.lang.Object value)
      Called whenever the view corresponding to a specific search field needs to be updated.
      void updateSearchFields()
      Called whenever a search field's visibility has changed.
      void updateSearchGroups()
      Called whenever a search field group's visibility has changed.
      void updateSelectedType()
      Called whenever the selected search type has changed.
      void updateSortFields()
      Called whenever the list of available sort fields, selected sort field or sort direction has changed.
      void updateTypes()
      Called whenever the list of available search types has changed.
      • 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

        focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, 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, equals, 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

        finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • initialized

        protected boolean initialized
      • SEARCH_MAGNIFIER_BTN_IMG

        protected static final java.lang.String SEARCH_MAGNIFIER_BTN_IMG
        See Also:
        Constant Field Values
      • EDIT_BTN_IMG_ACTIVE

        protected static final java.lang.String EDIT_BTN_IMG_ACTIVE
        See Also:
        Constant Field Values
    • Constructor Detail

      • AdvancedSearchView

        public AdvancedSearchView()
      • AdvancedSearchView

        public AdvancedSearchView​(java.util.List<? extends org.zkoss.zk.ui.Component> leftButtons,
                                  java.util.List<? extends org.zkoss.zk.ui.Component> rightButtons)
    • Method Detail

      • initialize

        public final boolean initialize()
        Description copied from interface: UIViewComponent
        Initializes this view component.

        Note: Should not be called during object creation i.e. from constructor.

        Returns:
        true if initialize was successful, false otherwise
      • renderEditArea

        protected void renderEditArea​(org.zkoss.zk.ui.Component parent)
      • renderEditSearchFieldEntries

        protected void renderEditSearchFieldEntries​(java.util.Collection<SearchField> entries,
                                                    org.zkoss.zk.ui.Component parent)
      • createEditSearchFieldEntry

        protected org.zkoss.zk.ui.Component createEditSearchFieldEntry​(SearchField field)
      • createSimpleRowComponent

        protected void createSimpleRowComponent​(org.zkoss.zk.ui.Component parent,
                                                java.lang.Object rawInitialValue,
                                                PropertyDescriptor propertyDescriptor,
                                                SearchField field,
                                                UIEditor editor)
      • fireActionPerformed

        protected void fireActionPerformed​(java.lang.String actionCode,
                                           SearchField field)
      • createSearchFieldRowComponent

        protected org.zkoss.zk.ui.Component createSearchFieldRowComponent​(SearchField field)
      • setModel

        public void setModel​(AdvancedSearchModel model)
        Description copied from interface: UIAdvancedSearchView
        Sets the model of this view component to model and initializes the view (if model is not null).
        Parameters:
        model - the model
      • updateSearchField

        public void updateSearchField​(SearchField searchField,
                                      java.lang.Object value)
        Description copied from interface: UIAdvancedSearchView
        Called whenever the view corresponding to a specific search field needs to be updated. You can specify a value which will be set as the editor value
        Parameters:
        searchField - the search field which has changed
        value - the value to set
      • updateSearchFields

        public void updateSearchFields()
        Description copied from interface: UIAdvancedSearchView
        Called whenever a search field's visibility has changed.
      • updateSearchGroups

        public void updateSearchGroups()
        Description copied from interface: UIAdvancedSearchView
        Called whenever a search field group's visibility has changed.
      • updateSelectedType

        public void updateSelectedType()
        Description copied from interface: UIAdvancedSearchView
        Called whenever the selected search type has changed.
      • updateTypes

        public void updateTypes()
        Description copied from interface: UIAdvancedSearchView
        Called whenever the list of available search types has changed.
      • updateSortFields

        public void updateSortFields()
        Description copied from interface: UIAdvancedSearchView
        Called whenever the list of available sort fields, selected sort field or sort direction has changed.
      • resizeCorrespondingContentBrowser

        protected void resizeCorrespondingContentBrowser()
      • update

        public boolean update()
        Description copied from interface: UIViewComponent
        Updates this view component completely.
        Returns:
        true if update was successful, false otherwise