Package com.saperion.ngc.iform.field.lookup

Interface InternalField

All Superinterfaces:
Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, Serializable
All Known Implementing Classes:
InternalDatebox, InternalDoublebox, InternalIntbox, InternalMultibox, InternalTextbox, InternalTimebox
public interface InternalField extends org.zkoss.zk.ui.Component
A field that is contained in an AdvancedLookupField.

  • Field Summary

    Fields inherited from interface org.zkoss.zk.ui.Component

    APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clears the value of the field.
    void
    clearErrorMessage()
    Clears the last error message.
    IntelligentField.ElementType
    getElementType()
     
    Object
    getObjectValue()
     
    com.saperion.intf.SaPropertyValue
    getPropertyValue()
     
    int
    getTabindex()
     
    String
    getText()
     
    boolean
    isDisabled()
     
    boolean
    isReadonly()
     
    boolean
    isValid()
     
    void
    setDisabled(boolean disabled)
    Sets the disabled-state of the field.
    void
    setObjectValue(Object value)
    Sets the field's value.
    void
    setPlaceholder(String placeholder)
    Sets the placeholder-text.
    void
    setPropertyValue(com.saperion.intf.SaPropertyValue value)
    Sets the field's value.
    default void
    setPropertyValue(com.saperion.intf.SaPropertyValue value, String separator)
    Sets the field's value.
    void
    setReadonly(boolean readonly)
    Sets the readonly-state of the field.
    void
    setTabindex(int index)
    Sets the tabindex of the field.
    void
    setText(String text)
    Sets the field's value as text.
    void
    smartUpdate(String attr, Object value)
    Updates the specified attribute.
    void
    validate(Object value)
    Validates the value.

    Methods inherited from interface org.zkoss.zk.ui.Component

    addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride

    Methods inherited from interface org.zkoss.zk.ui.ext.Scope

    addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

  • Method Details

    • setObjectValue

      void setObjectValue(Object value)
      Sets the field's value. Multivalue fields accept a typed Collection.
      Parameters:
      value - new value to set

    • setPropertyValue

      void setPropertyValue(com.saperion.intf.SaPropertyValue value)
      Sets the field's value.
      Parameters:
      value - new value to set

    • getPropertyValue

      com.saperion.intf.SaPropertyValue getPropertyValue()
      Returns:
      the field's current value as SaPropertyValue.

    • setPropertyValue

      default void setPropertyValue(com.saperion.intf.SaPropertyValue value, String separator)
      Sets the field's value.
      Parameters:
      value - new value to set
      separator - use if value contains more than one value which needs to be appended

    • getObjectValue

      Object getObjectValue()
      Returns:
      the field's current value or null if the field is empty.

    • smartUpdate

      void smartUpdate(String attr, Object value)
      Updates the specified attribute.
      Parameters:
      attr - name of the attribute
      value - new value of the attribute

    • validate

      void validate(Object value)
      Validates the value.
      Parameters:
      value - value to validate

    • clear

      void clear()
      Clears the value of the field.

    • getElementType

      IntelligentField.ElementType getElementType()
      Returns:
      the IntelligentField.ElementType of the field

    • setTabindex

      void setTabindex(int index)
      Sets the tabindex of the field.
      Parameters:
      index - the tabindex

    • getTabindex

      int getTabindex()
      Returns:
      the field's tab-index

    • getText

      String getText()
      Returns:
      the field's value as text

    • setText

      void setText(String text)
      Sets the field's value as text.
      Parameters:
      text - value as text

    • isReadonly

      boolean isReadonly()
      Returns:
      true if the field is in readonly-mode

    • isDisabled

      boolean isDisabled()
      Returns:
      true if the field is disabled

    • setDisabled

      void setDisabled(boolean disabled)
      Sets the disabled-state of the field.
      Parameters:
      disabled - disabled state

    • setReadonly

      void setReadonly(boolean readonly)
      Sets the readonly-state of the field.
      Parameters:
      readonly - readonly state

    • isValid

      boolean isValid()
      Returns:
      true if the field's content is valid

    • clearErrorMessage

      void clearErrorMessage()
      Clears the last error message.

    • setPlaceholder

      void setPlaceholder(String placeholder)
      Sets the placeholder-text.
      Parameters:
      placeholder - the placeholder text
      See Also:
      • InputElement.setPlaceholder(String)