Class UIParameter

    • Field Detail

      • COMPONENT_TYPE

        public static final String COMPONENT_TYPE

        The standard component type for this component.

        See Also:
        Constant Field Values
      • COMPONENT_FAMILY

        public static final String COMPONENT_FAMILY

        The standard component family for this component.

        See Also:
        Constant Field Values
    • Constructor Detail

      • UIParameter

        public UIParameter()

        Create a new UIParameter instance with default property values.

    • Method Detail

      • getFamily

        public String getFamily()
        Description copied from class: UIComponent

        Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

        Specified by:
        getFamily in class UIComponent
        Returns:
        the component family (not null).
      • getName

        public String getName()

        Return the optional parameter name for this parameter.

        Returns:
        the name.
      • setName

        public void setName​(String name)

        Set the optional parameter name for this parameter.

        Parameters:
        name - The new parameter name, or null for no name
      • getValue

        public Object getValue()

        Returns the value property of the UIParameter.

        Returns:
        the value.
      • setValue

        public void setValue​(Object value)

        Sets the value property of the\ UIParameter.

        Parameters:
        value - the new value
      • isDisable

        public boolean isDisable()

        Return the value of the disable directive for this component. This directive determines whether the parameter value should be disabled by assigning it a null value. If true, the value set on this component is ignored.

        Returns:
        true if disabled, false otherwise.
        Since:
        2.0
      • setDisable

        public void setDisable​(boolean disable)

        Sets the disable property of the UIParameter.

        Parameters:
        disable - the value for the disable flag.
        Since:
        2.0