Interface DynamicPropertied

  • All Known Subinterfaces:
    DynamicTag, Macro
    All Known Implementing Classes:
    HtmlMacroComponent, HtmlNativeComponent

    public interface DynamicPropertied
    Represents a component that supports a range of properties. It is used to simplify the design of a component, such that developers need to implement member functions (setter and getter) for each property it supports.
    Author:
    tomyeh
    • Method Detail

      • hasDynamicProperty

        boolean hasDynamicProperty​(java.lang.String name)
        Returns whether a dynamic property is defined.
      • getDynamicProperty

        java.lang.Object getDynamicProperty​(java.lang.String name)
        Returns the property value of the specified name.
      • setDynamicProperty

        void setDynamicProperty​(java.lang.String name,
                                java.lang.Object value)
                         throws WrongValueException
        Sets a property with the specified name and value.

        If a component supports only String-type values, it could use org.zkoss.lang.Objects.toString() to convert the value to a String instance.

        Throws:
        WrongValueException
      • getDynamicProperties

        default java.util.Map<java.lang.String,​java.lang.Object> getDynamicProperties()
        Returns all available dynamic properties.
        Since:
        10.0.0