FreeFormLayoutElement (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.FreeFormLayoutElement

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<FreeFormLayoutElement.Builder,FreeFormLayoutElement>

@Generated(value="software.amazon.awssdk:codegen")
public final class FreeFormLayoutElement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FreeFormLayoutElement.Builder,FreeFormLayoutElement>

An element within a free-form layout.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FreeFormLayoutElement.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FreeFormLayoutElement.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FreeFormLayoutElementBackgroundStyle`	`backgroundStyle()` The background style configuration of a free-form layout element.
`FreeFormLayoutElementBorderStyle`	`borderStyle()` The border style configuration of a free-form layout element.
`static FreeFormLayoutElement.Builder`	`builder()`
`String`	`elementId()` A unique identifier for an element within a free-form layout.
`LayoutElementType`	`elementType()` The type of element.
`String`	`elementTypeAsString()` The type of element.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRenderingRules()` For responses, this returns true if the service returned a value for the RenderingRules property.
`String`	`height()` The height of an element within a free-form layout.
`LoadingAnimation`	`loadingAnimation()` The loading animation configuration of a free-form layout element.
`List<SheetElementRenderingRule>`	`renderingRules()` The rendering rules that determine when an element should be displayed within a free-form layout.
`List<SdkField<?>>`	`sdkFields()`
`FreeFormLayoutElementBorderStyle`	`selectedBorderStyle()` The border style configuration of a free-form layout element.
`static Class<? extends FreeFormLayoutElement.Builder>`	`serializableBuilderClass()`
`FreeFormLayoutElement.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Visibility`	`visibility()` The visibility of an element within a free-form layout.
`String`	`visibilityAsString()` The visibility of an element within a free-form layout.
`String`	`width()` The width of an element within a free-form layout.
`String`	`xAxisLocation()` The x-axis coordinate of the element.
`String`	`yAxisLocation()` The y-axis coordinate of the element.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - elementId
```
public final String elementId()
```
    A unique identifier for an element within a free-form layout.
    
    Returns:
    
    A unique identifier for an element within a free-form layout.
  - elementType
```
public final LayoutElementType elementType()
```
    The type of element.
    
    If the service returns an enum value that is not available in the current SDK version, elementType will return LayoutElementType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from elementTypeAsString().
    
    Returns:
    
    The type of element.
    
    See Also:
    
    LayoutElementType
  - elementTypeAsString
```
public final String elementTypeAsString()
```
    The type of element.
    
    If the service returns an enum value that is not available in the current SDK version, elementType will return LayoutElementType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from elementTypeAsString().
    
    Returns:
    
    The type of element.
    
    See Also:
    
    LayoutElementType
  - xAxisLocation
```
public final String xAxisLocation()
```
    The x-axis coordinate of the element.
    
    Returns:
    
    The x-axis coordinate of the element.
  - yAxisLocation
```
public final String yAxisLocation()
```
    The y-axis coordinate of the element.
    
    Returns:
    
    The y-axis coordinate of the element.
  - width
```
public final String width()
```
    The width of an element within a free-form layout.
    
    Returns:
    
    The width of an element within a free-form layout.
  - height
```
public final String height()
```
    The height of an element within a free-form layout.
    
    Returns:
    
    The height of an element within a free-form layout.
  - visibility
```
public final Visibility visibility()
```
    The visibility of an element within a free-form layout.
    
    If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().
    
    Returns:
    
    The visibility of an element within a free-form layout.
    
    See Also:
    
    Visibility
  - visibilityAsString
```
public final String visibilityAsString()
```
    The visibility of an element within a free-form layout.
    
    If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().
    
    Returns:
    
    The visibility of an element within a free-form layout.
    
    See Also:
    
    Visibility
  - hasRenderingRules
```
public final boolean hasRenderingRules()
```
    For responses, this returns true if the service returned a value for the RenderingRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - renderingRules
```
public final List<SheetElementRenderingRule> renderingRules()
```
    The rendering rules that determine when an element should be displayed within a free-form layout.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRenderingRules() method.
    
    Returns:
    
    The rendering rules that determine when an element should be displayed within a free-form layout.
  - borderStyle
```
public final FreeFormLayoutElementBorderStyle borderStyle()
```
    The border style configuration of a free-form layout element.
    
    Returns:
    
    The border style configuration of a free-form layout element.
  - selectedBorderStyle
```
public final FreeFormLayoutElementBorderStyle selectedBorderStyle()
```
    The border style configuration of a free-form layout element. This border style is used when the element is selected.
    
    Returns:
    
    The border style configuration of a free-form layout element. This border style is used when the element is selected.
  - backgroundStyle
```
public final FreeFormLayoutElementBackgroundStyle backgroundStyle()
```
    The background style configuration of a free-form layout element.
    
    Returns:
    
    The background style configuration of a free-form layout element.
  - loadingAnimation
```
public final LoadingAnimation loadingAnimation()
```
    The loading animation configuration of a free-form layout element.
    
    Returns:
    
    The loading animation configuration of a free-form layout element.
  - toBuilder
```
public FreeFormLayoutElement.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FreeFormLayoutElement.Builder,FreeFormLayoutElement>
  - builder
```
public static FreeFormLayoutElement.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FreeFormLayoutElement.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class FreeFormLayoutElement

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

elementId

elementType

elementTypeAsString

xAxisLocation

yAxisLocation

width

height

visibility

visibilityAsString

hasRenderingRules

renderingRules

borderStyle

selectedBorderStyle

backgroundStyle

loadingAnimation

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields