WidgetItem (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.WidgetItem

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class WidgetItem
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Represents a reference to a widget that is held by a container or a multi-widget or a View.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WidgetItem.Builder
Builder class for WidgetItem.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ALIGNMENT_LEFT`
`static java.lang.String`	`ALIGNMENT_RIGHT`

Constructor Summary

Constructors
Modifier Constructor and Description

WidgetItem()
Default constructor.

protected WidgetItem(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`WidgetItem()` Default constructor.
`protected`	`WidgetItem(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 WidgetItem`	`_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 WidgetItem`	`_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`	`getAlignment()` Possible values are: `ALIGNMENT_LEFT` `ALIGNMENT_RIGHT` Aligns widget either left or right.
`Label`	`getLabel()`
`java.lang.Long`	`getRowspan()` Represents the vertical span of the widget / container format: int32
`java.lang.Boolean`	`getSeparator()` If true, separates this widget in a container.
`java.lang.Long`	`getSpan()` Represents the horizontal span of the widget / container.
`java.lang.Long`	`getWeight()` Determines placement of widget or container relative to other widgets and containers.
`java.lang.String`	`getWidgetId()` Id of the widget configuration that is held by a multi-widget or a container or a view.
`int`	`hashCode()`
`void`	`setAlignment(java.lang.String alignment)` Possible values are: `ALIGNMENT_LEFT` `ALIGNMENT_RIGHT` Aligns widget either left or right.
`void`	`setLabel(Label label)`
`void`	`setRowspan(java.lang.Long rowspan)` Represents the vertical span of the widget / container format: int32
`void`	`setSeparator(java.lang.Boolean separator)` If true, separates this widget in a container.
`void`	`setSpan(java.lang.Long span)` Represents the horizontal span of the widget / container.
`void`	`setWeight(java.lang.Long weight)` Determines placement of widget or container relative to other widgets and containers.
`void`	`setWidgetId(java.lang.String widgetId)` Id of the widget configuration that is held by a multi-widget or a container or a view.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ALIGNMENT_LEFT
```
public static final java.lang.String ALIGNMENT_LEFT
```
    See Also:
    
    Constant Field Values
  - ALIGNMENT_RIGHT
```
public static final java.lang.String ALIGNMENT_RIGHT
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - WidgetItem
```
public WidgetItem()
```
    Default constructor.
  - WidgetItem
```
protected WidgetItem(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAlignment
```
public java.lang.String getAlignment()
```
    Possible values are:
    - ALIGNMENT_LEFT
    - ALIGNMENT_RIGHT
    Aligns widget either left or right.
    Returns:
    
    The current value of the property.
  - setAlignment
```
public void setAlignment(java.lang.String alignment)
```
    Possible values are:
    - ALIGNMENT_LEFT
    - ALIGNMENT_RIGHT
    Aligns widget either left or right.
    Parameters:
    
    alignment - New value for the property.
  - getLabel
```
public Label getLabel()
```
    Returns:
    
    The current value of the property.
  - setLabel
```
public void setLabel(Label label)
```
    Parameters:
    
    label - New value for the property.
  - getRowspan
```
public java.lang.Long getRowspan()
```
    Represents the vertical span of the widget / container format: int32
    
    Returns:
    
    The current value of the property.
  - setRowspan
```
public void setRowspan(java.lang.Long rowspan)
```
    Represents the vertical span of the widget / container format: int32
    
    Parameters:
    
    rowspan - New value for the property.
  - getSeparator
```
public java.lang.Boolean getSeparator()
```
    If true, separates this widget in a container.
    
    Returns:
    
    The current value of the property.
  - setSeparator
```
public void setSeparator(java.lang.Boolean separator)
```
    If true, separates this widget in a container.
    
    Parameters:
    
    separator - New value for the property.
  - getSpan
```
public java.lang.Long getSpan()
```
    Represents the horizontal span of the widget / container. format: int32
    
    Returns:
    
    The current value of the property.
  - setSpan
```
public void setSpan(java.lang.Long span)
```
    Represents the horizontal span of the widget / container. format: int32
    
    Parameters:
    
    span - New value for the property.
  - getWeight
```
public java.lang.Long getWeight()
```
    Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order. format: int32
    
    Returns:
    
    The current value of the property.
  - setWeight
```
public void setWeight(java.lang.Long weight)
```
    Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order. format: int32
    
    Parameters:
    
    weight - New value for the property.
  - getWidgetId
```
public java.lang.String getWidgetId()
```
    Id of the widget configuration that is held by a multi-widget or a container or a view.
    
    Returns:
    
    The current value of the property.
  - setWidgetId
```
public void setWidgetId(java.lang.String widgetId)
```
    Id of the widget configuration that is held by a multi-widget or a container or a view.
    
    Parameters:
    
    widgetId - 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 WidgetItem _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 WidgetItem _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class WidgetItem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALIGNMENT_LEFT

ALIGNMENT_RIGHT

__dynamicStructureFields

Constructor Detail

WidgetItem

WidgetItem

Method Detail

getAlignment

setAlignment

getLabel

setLabel

getRowspan

setRowspan

getSeparator

setSeparator

getSpan

setSpan

getWeight

setWeight

getWidgetId

setWidgetId

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2