Package com.saperion.ngc.searchbox

Class Searchbox

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Box
org.zkoss.zul.Hbox
com.saperion.ngc.searchbox.Searchbox
All Implemented Interfaces:
Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
public class Searchbox extends org.zkoss.zul.Hbox
A custom searchbox component with two buttons. One to clear the value, one to start the search.
See Also:

  • 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 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
    Searchbox()
    Simple constructor.
    Searchbox(String value)
    Constructor with predefined value.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.zkoss.zul.Toolbarbutton
    getDeleteButton()
     
    org.zkoss.zul.Toolbarbutton
    getSearchButton()
     
    org.zkoss.zul.Textbox
    getTextbox()
     
    String
    getValue()
     
    boolean
    isDisabled()
     
    void
    setDisabled(boolean value)
    Set disabled state.
    void
    setText(String value)
    Sets the textbox's text.
    void
    setValue(String value)
    Sets the textbox's value.
    void
    showPopup(String message)
     
    void
    signalizeError(boolean signalize)
    Changes the look of the searchbox to signal an error.
    void
    unWatermarkFilterInputField()
    Removes the watermark from the filter input field.
    void
    watermarkFilterInputField()
    Sets the watermark for the filter input field.

    Methods inherited from class org.zkoss.zul.Box

    evalCSSFlex, getAlign, getHeights, getOrient, getPack, getSpacing, getWidths, getZclass, isHorizontal, isSizedByContent, isVertical, renderProperties, setAlign, setHeights, setOrient, setPack, setSizedByContent, setSpacing, setWidths

    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, 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, invalidatePartial, isChildable, isInitialized, 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

    Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

    invalidatePartial

  • Constructor Details

    • Searchbox

      public Searchbox()
      Simple constructor.

    • Searchbox

      public Searchbox(String value)
      Constructor with predefined value.
      Parameters:
      value - textbox value

  • Method Details

    • watermarkFilterInputField

      public void watermarkFilterInputField()
      Sets the watermark for the filter input field. To hide the watermark use unWatermarkFilterInputField().

    • unWatermarkFilterInputField

      public void unWatermarkFilterInputField()
      Removes the watermark from the filter input field.

    • getValue

      public String getValue()
      Returns:
      textbox value

    • setValue

      public void setValue(String value)
      Sets the textbox's value.
      Parameters:
      value - value
      See Also:
      • Textbox.setValue(String)

    • setText

      public void setText(String value)
      Sets the textbox's text.
      Parameters:
      value - text
      See Also:
      • InputElement.setText(String)

    • getTextbox

      public org.zkoss.zul.Textbox getTextbox()
      Returns:
      internal textbox

    • getSearchButton

      public org.zkoss.zul.Toolbarbutton getSearchButton()
      Returns:
      internal search button

    • getDeleteButton

      public org.zkoss.zul.Toolbarbutton getDeleteButton()
      Returns:
      internal delete button

    • showPopup

      public void showPopup(String message)
      Parameters:
      message - Message

    • signalizeError

      public void signalizeError(boolean signalize)
      Changes the look of the searchbox to signal an error.
      Parameters:
      signalize - true to signalize error, false to reset

    • setDisabled

      public void setDisabled(boolean value)
      Set disabled state.
      Parameters:
      value - true to disable

    • isDisabled

      public boolean isDisabled()
      Returns:
      disabled state