FreeFormLayoutElement (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.FreeFormLayoutElement

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FreeFormLayoutElement
extends Object
implements Serializable, Cloneable, StructuredPojo

An element within a free-form layout.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FreeFormLayoutElement()

Constructors
Constructor and Description
`FreeFormLayoutElement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FreeFormLayoutElement`	`clone()`
`boolean`	`equals(Object obj)`
`FreeFormLayoutElementBackgroundStyle`	`getBackgroundStyle()` The background style configuration of a free-form layout element.
`FreeFormLayoutElementBorderStyle`	`getBorderStyle()` The border style configuration of a free-form layout element.
`String`	`getElementId()` A unique identifier for an element within a free-form layout.
`String`	`getElementType()` The type of element.
`String`	`getHeight()` The height of an element within a free-form layout.
`LoadingAnimation`	`getLoadingAnimation()` The loading animation configuration of a free-form layout element.
`List<SheetElementRenderingRule>`	`getRenderingRules()` The rendering rules that determine when an element should be displayed within a free-form layout.
`FreeFormLayoutElementBorderStyle`	`getSelectedBorderStyle()` The border style configuration of a free-form layout element.
`String`	`getVisibility()` The visibility of an element within a free-form layout.
`String`	`getWidth()` The width of an element within a free-form layout.
`String`	`getXAxisLocation()` The x-axis coordinate of the element.
`String`	`getYAxisLocation()` The y-axis coordinate of the element.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBackgroundStyle(FreeFormLayoutElementBackgroundStyle backgroundStyle)` The background style configuration of a free-form layout element.
`void`	`setBorderStyle(FreeFormLayoutElementBorderStyle borderStyle)` The border style configuration of a free-form layout element.
`void`	`setElementId(String elementId)` A unique identifier for an element within a free-form layout.
`void`	`setElementType(String elementType)` The type of element.
`void`	`setHeight(String height)` The height of an element within a free-form layout.
`void`	`setLoadingAnimation(LoadingAnimation loadingAnimation)` The loading animation configuration of a free-form layout element.
`void`	`setRenderingRules(Collection<SheetElementRenderingRule> renderingRules)` The rendering rules that determine when an element should be displayed within a free-form layout.
`void`	`setSelectedBorderStyle(FreeFormLayoutElementBorderStyle selectedBorderStyle)` The border style configuration of a free-form layout element.
`void`	`setVisibility(String visibility)` The visibility of an element within a free-form layout.
`void`	`setWidth(String width)` The width of an element within a free-form layout.
`void`	`setXAxisLocation(String xAxisLocation)` The x-axis coordinate of the element.
`void`	`setYAxisLocation(String yAxisLocation)` The y-axis coordinate of the element.
`String`	`toString()` Returns a string representation of this object.
`FreeFormLayoutElement`	`withBackgroundStyle(FreeFormLayoutElementBackgroundStyle backgroundStyle)` The background style configuration of a free-form layout element.
`FreeFormLayoutElement`	`withBorderStyle(FreeFormLayoutElementBorderStyle borderStyle)` The border style configuration of a free-form layout element.
`FreeFormLayoutElement`	`withElementId(String elementId)` A unique identifier for an element within a free-form layout.
`FreeFormLayoutElement`	`withElementType(LayoutElementType elementType)` The type of element.
`FreeFormLayoutElement`	`withElementType(String elementType)` The type of element.
`FreeFormLayoutElement`	`withHeight(String height)` The height of an element within a free-form layout.
`FreeFormLayoutElement`	`withLoadingAnimation(LoadingAnimation loadingAnimation)` The loading animation configuration of a free-form layout element.
`FreeFormLayoutElement`	`withRenderingRules(Collection<SheetElementRenderingRule> renderingRules)` The rendering rules that determine when an element should be displayed within a free-form layout.
`FreeFormLayoutElement`	`withRenderingRules(SheetElementRenderingRule... renderingRules)` The rendering rules that determine when an element should be displayed within a free-form layout.
`FreeFormLayoutElement`	`withSelectedBorderStyle(FreeFormLayoutElementBorderStyle selectedBorderStyle)` The border style configuration of a free-form layout element.
`FreeFormLayoutElement`	`withVisibility(String visibility)` The visibility of an element within a free-form layout.
`FreeFormLayoutElement`	`withVisibility(Visibility visibility)` The visibility of an element within a free-form layout.
`FreeFormLayoutElement`	`withWidth(String width)` The width of an element within a free-form layout.
`FreeFormLayoutElement`	`withXAxisLocation(String xAxisLocation)` The x-axis coordinate of the element.
`FreeFormLayoutElement`	`withYAxisLocation(String yAxisLocation)` The y-axis coordinate of the element.

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

- Constructor Detail
  - FreeFormLayoutElement
```
public FreeFormLayoutElement()
```
- Method Detail
  - setElementId
```
public void setElementId(String elementId)
```
    A unique identifier for an element within a free-form layout.
    
    Parameters:
    
    elementId - A unique identifier for an element within a free-form layout.
  - getElementId
```
public String getElementId()
```
    A unique identifier for an element within a free-form layout.
    
    Returns:
    
    A unique identifier for an element within a free-form layout.
  - withElementId
```
public FreeFormLayoutElement withElementId(String elementId)
```
    A unique identifier for an element within a free-form layout.
    
    Parameters:
    
    elementId - A unique identifier for an element within a free-form layout.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setElementType
```
public void setElementType(String elementType)
```
    The type of element.
    
    Parameters:
    
    elementType - The type of element.
    
    See Also:
    
    LayoutElementType
  - getElementType
```
public String getElementType()
```
    The type of element.
    
    Returns:
    
    The type of element.
    
    See Also:
    
    LayoutElementType
  - withElementType
```
public FreeFormLayoutElement withElementType(String elementType)
```
    The type of element.
    
    Parameters:
    
    elementType - The type of element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LayoutElementType
  - withElementType
```
public FreeFormLayoutElement withElementType(LayoutElementType elementType)
```
    The type of element.
    
    Parameters:
    
    elementType - The type of element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LayoutElementType
  - setXAxisLocation
```
public void setXAxisLocation(String xAxisLocation)
```
    The x-axis coordinate of the element.
    
    Parameters:
    
    xAxisLocation - The x-axis coordinate of the element.
  - getXAxisLocation
```
public String getXAxisLocation()
```
    The x-axis coordinate of the element.
    
    Returns:
    
    The x-axis coordinate of the element.
  - withXAxisLocation
```
public FreeFormLayoutElement withXAxisLocation(String xAxisLocation)
```
    The x-axis coordinate of the element.
    
    Parameters:
    
    xAxisLocation - The x-axis coordinate of the element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setYAxisLocation
```
public void setYAxisLocation(String yAxisLocation)
```
    The y-axis coordinate of the element.
    
    Parameters:
    
    yAxisLocation - The y-axis coordinate of the element.
  - getYAxisLocation
```
public String getYAxisLocation()
```
    The y-axis coordinate of the element.
    
    Returns:
    
    The y-axis coordinate of the element.
  - withYAxisLocation
```
public FreeFormLayoutElement withYAxisLocation(String yAxisLocation)
```
    The y-axis coordinate of the element.
    
    Parameters:
    
    yAxisLocation - The y-axis coordinate of the element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWidth
```
public void setWidth(String width)
```
    The width of an element within a free-form layout.
    
    Parameters:
    
    width - The width of an element within a free-form layout.
  - getWidth
```
public String getWidth()
```
    The width of an element within a free-form layout.
    
    Returns:
    
    The width of an element within a free-form layout.
  - withWidth
```
public FreeFormLayoutElement withWidth(String width)
```
    The width of an element within a free-form layout.
    
    Parameters:
    
    width - The width of an element within a free-form layout.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeight
```
public void setHeight(String height)
```
    The height of an element within a free-form layout.
    
    Parameters:
    
    height - The height of an element within a free-form layout.
  - getHeight
```
public String getHeight()
```
    The height of an element within a free-form layout.
    
    Returns:
    
    The height of an element within a free-form layout.
  - withHeight
```
public FreeFormLayoutElement withHeight(String height)
```
    The height of an element within a free-form layout.
    
    Parameters:
    
    height - The height of an element within a free-form layout.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVisibility
```
public void setVisibility(String visibility)
```
    The visibility of an element within a free-form layout.
    
    Parameters:
    
    visibility - The visibility of an element within a free-form layout.
    
    See Also:
    
    Visibility
  - getVisibility
```
public String getVisibility()
```
    The visibility of an element within a free-form layout.
    
    Returns:
    
    The visibility of an element within a free-form layout.
    
    See Also:
    
    Visibility
  - withVisibility
```
public FreeFormLayoutElement withVisibility(String visibility)
```
    The visibility of an element within a free-form layout.
    
    Parameters:
    
    visibility - The visibility of an element within a free-form layout.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - withVisibility
```
public FreeFormLayoutElement withVisibility(Visibility visibility)
```
    The visibility of an element within a free-form layout.
    
    Parameters:
    
    visibility - The visibility of an element within a free-form layout.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Visibility
  - getRenderingRules
```
public List<SheetElementRenderingRule> getRenderingRules()
```
    The rendering rules that determine when an element should be displayed within a free-form layout.
    
    Returns:
    
    The rendering rules that determine when an element should be displayed within a free-form layout.
  - setRenderingRules
```
public void setRenderingRules(Collection<SheetElementRenderingRule> renderingRules)
```
    The rendering rules that determine when an element should be displayed within a free-form layout.
    
    Parameters:
    
    renderingRules - The rendering rules that determine when an element should be displayed within a free-form layout.
  - withRenderingRules
```
public FreeFormLayoutElement withRenderingRules(SheetElementRenderingRule... renderingRules)
```
    The rendering rules that determine when an element should be displayed within a free-form layout.
    
    NOTE: This method appends the values to the existing list (if any). Use setRenderingRules(java.util.Collection) or withRenderingRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    renderingRules - The rendering rules that determine when an element should be displayed within a free-form layout.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRenderingRules
```
public FreeFormLayoutElement withRenderingRules(Collection<SheetElementRenderingRule> renderingRules)
```
    The rendering rules that determine when an element should be displayed within a free-form layout.
    
    Parameters:
    
    renderingRules - The rendering rules that determine when an element should be displayed within a free-form layout.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBorderStyle
```
public void setBorderStyle(FreeFormLayoutElementBorderStyle borderStyle)
```
    The border style configuration of a free-form layout element.
    
    Parameters:
    
    borderStyle - The border style configuration of a free-form layout element.
  - getBorderStyle
```
public FreeFormLayoutElementBorderStyle getBorderStyle()
```
    The border style configuration of a free-form layout element.
    
    Returns:
    
    The border style configuration of a free-form layout element.
  - withBorderStyle
```
public FreeFormLayoutElement withBorderStyle(FreeFormLayoutElementBorderStyle borderStyle)
```
    The border style configuration of a free-form layout element.
    
    Parameters:
    
    borderStyle - The border style configuration of a free-form layout element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSelectedBorderStyle
```
public void setSelectedBorderStyle(FreeFormLayoutElementBorderStyle selectedBorderStyle)
```
    The border style configuration of a free-form layout element. This border style is used when the element is selected.
    
    Parameters:
    
    selectedBorderStyle - The border style configuration of a free-form layout element. This border style is used when the element is selected.
  - getSelectedBorderStyle
```
public FreeFormLayoutElementBorderStyle getSelectedBorderStyle()
```
    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.
  - withSelectedBorderStyle
```
public FreeFormLayoutElement withSelectedBorderStyle(FreeFormLayoutElementBorderStyle selectedBorderStyle)
```
    The border style configuration of a free-form layout element. This border style is used when the element is selected.
    
    Parameters:
    
    selectedBorderStyle - The border style configuration of a free-form layout element. This border style is used when the element is selected.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackgroundStyle
```
public void setBackgroundStyle(FreeFormLayoutElementBackgroundStyle backgroundStyle)
```
    The background style configuration of a free-form layout element.
    
    Parameters:
    
    backgroundStyle - The background style configuration of a free-form layout element.
  - getBackgroundStyle
```
public FreeFormLayoutElementBackgroundStyle getBackgroundStyle()
```
    The background style configuration of a free-form layout element.
    
    Returns:
    
    The background style configuration of a free-form layout element.
  - withBackgroundStyle
```
public FreeFormLayoutElement withBackgroundStyle(FreeFormLayoutElementBackgroundStyle backgroundStyle)
```
    The background style configuration of a free-form layout element.
    
    Parameters:
    
    backgroundStyle - The background style configuration of a free-form layout element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoadingAnimation
```
public void setLoadingAnimation(LoadingAnimation loadingAnimation)
```
    The loading animation configuration of a free-form layout element.
    
    Parameters:
    
    loadingAnimation - The loading animation configuration of a free-form layout element.
  - getLoadingAnimation
```
public LoadingAnimation getLoadingAnimation()
```
    The loading animation configuration of a free-form layout element.
    
    Returns:
    
    The loading animation configuration of a free-form layout element.
  - withLoadingAnimation
```
public FreeFormLayoutElement withLoadingAnimation(LoadingAnimation loadingAnimation)
```
    The loading animation configuration of a free-form layout element.
    
    Parameters:
    
    loadingAnimation - The loading animation configuration of a free-form layout element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FreeFormLayoutElement clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class FreeFormLayoutElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FreeFormLayoutElement

Method Detail

setElementId

getElementId

withElementId

setElementType

getElementType

withElementType

withElementType

setXAxisLocation

getXAxisLocation

withXAxisLocation

setYAxisLocation

getYAxisLocation

withYAxisLocation

setWidth

getWidth

withWidth

setHeight

getHeight

withHeight

setVisibility

getVisibility

withVisibility

withVisibility

getRenderingRules

setRenderingRules

withRenderingRules

withRenderingRules

setBorderStyle

getBorderStyle

withBorderStyle

setSelectedBorderStyle

getSelectedBorderStyle

withSelectedBorderStyle

setBackgroundStyle

getBackgroundStyle

withBackgroundStyle

setLoadingAnimation

getLoadingAnimation

withLoadingAnimation

toString

equals

hashCode

clone

marshall