Package com.vmware.nsx_policy.model

Class Icon

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class Icon
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Icon to be applied at dashboard for widgets and UI elements.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Icon.Builder
      Builder class for Icon.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        Icon()
      Default constructor.
      protected Icon​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends com.vmware.vapi.bindings.Structure>
      T      		 _convertTo​(java.lang.Class<T> clazz)  
      java.lang.String _getCanonicalName()  
      static java.lang.String _getCanonicalTypeName()
      Returns the canonical type name.
      static com.vmware.vapi.bindings.type.StructType _getClassType()
      WARNING: Internal method, subject to change in future versions.
      com.vmware.vapi.data.StructValue _getDataValue()  
      com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)  
      java.util.Set<java.lang.String> _getDynamicFieldNames()  
      com.vmware.vapi.bindings.type.StructType _getType()  
      boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)  
      static Icon _newInstance​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Returns new instance of this binding class and injects the provided data value.
      WARNING: The returned object is not fully initialized.
      static Icon _newInstance2​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)  
      protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)  
      void _validate()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getColor()
      Icon color applied to icon in hex format.
      java.lang.String getPlacement()
      Possible values are: PLACEMENT_PRE PLACEMENT_POST If specified as PRE, the icon appears before the UI element.
      java.lang.Double getSize()
      Icon size in unit applied to icon.A unit can be specified by the 'size_unit' property.
      java.lang.String getSizeUnit()
      Possible values are: SIZE_UNIT_PX SIZE_UNIT_REM SIZE_UNIT_PC Icon size unit applied to icon along with size.
      java.util.List<Tooltip> getTooltip()
      Multi-line text to be shown on tooltip while hovering over the icon.
      java.lang.String getType()
      Icon will be rendered based on its type.
      int hashCode()  
      void setColor​(java.lang.String color)
      Icon color applied to icon in hex format.
      void setPlacement​(java.lang.String placement)
      Possible values are: PLACEMENT_PRE PLACEMENT_POST If specified as PRE, the icon appears before the UI element.
      void setSize​(java.lang.Double size)
      Icon size in unit applied to icon.A unit can be specified by the 'size_unit' property.
      void setSizeUnit​(java.lang.String sizeUnit)
      Possible values are: SIZE_UNIT_PX SIZE_UNIT_REM SIZE_UNIT_PC Icon size unit applied to icon along with size.
      void setTooltip​(java.util.List<Tooltip> tooltip)
      Multi-line text to be shown on tooltip while hovering over the icon.
      void setType​(java.lang.String type)
      Icon will be rendered based on its type.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • Icon

        public Icon()
        Default constructor.

      • Icon

        protected Icon​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getColor

        public java.lang.String getColor()
        Icon color applied to icon in hex format.
        Returns:
        The current value of the property.

      • setColor

        public void setColor​(java.lang.String color)
        Icon color applied to icon in hex format.
        Parameters:
        color - New value for the property.

      • getPlacement

        public java.lang.String getPlacement()
        Possible values are: If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.
        Returns:
        The current value of the property.

      • setPlacement

        public void setPlacement​(java.lang.String placement)
        Possible values are: If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.
        Parameters:
        placement - New value for the property.

      • getSize

        public java.lang.Double getSize()
        Icon size in unit applied to icon.A unit can be specified by the 'size_unit' property.
        Returns:
        The current value of the property.

      • setSize

        public void setSize​(java.lang.Double size)
        Icon size in unit applied to icon.A unit can be specified by the 'size_unit' property.
        Parameters:
        size - New value for the property.

      • getSizeUnit

        public java.lang.String getSizeUnit()
        Possible values are: Icon size unit applied to icon along with size. if 'size' property value is provided and no value is provided for this property then default value for this proerty is set to 'px'.
        Returns:
        The current value of the property.

      • setSizeUnit

        public void setSizeUnit​(java.lang.String sizeUnit)
        Possible values are: Icon size unit applied to icon along with size. if 'size' property value is provided and no value is provided for this property then default value for this proerty is set to 'px'.
        Parameters:
        sizeUnit - New value for the property.

      • getTooltip

        public java.util.List<Tooltip> getTooltip()
        Multi-line text to be shown on tooltip while hovering over the icon.
        Returns:
        The current value of the property.

      • setTooltip

        public void setTooltip​(java.util.List<Tooltip> tooltip)
        Multi-line text to be shown on tooltip while hovering over the icon.
        Parameters:
        tooltip - New value for the property.

      • getType

        public java.lang.String getType()
        Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered. or else custom svg icon name can be given.
        Returns:
        The current value of the property.

      • setType

        public void setType​(java.lang.String type)
        Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered. or else custom svg icon name can be given.
        Parameters:
        type - New value for the property.

      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure

      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure

      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)

      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object

      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure

      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

      • _getClassType

        public static com.vmware.vapi.bindings.type.StructType _getClassType()
        WARNING: Internal method, subject to change in future versions.
        Returns:
        StructType instance representing the static bindings type for this Structure.

      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure

      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name

      • _newInstance

        public static Icon _newInstance​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Returns new instance of this binding class and injects the provided data value.
        WARNING: The returned object is not fully initialized.
        Parameters:
        structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
        Returns:
        the static bindings StructType

      • _newInstance2

        public static Icon _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.