Class FreeFormLayoutElement
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FreeFormLayoutElement.Builder,
FreeFormLayoutElement>
An element within a free-form layout.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe background style configuration of a free-form layout element.The border style configuration of a free-form layout element.builder()
final String
A unique identifier for an element within a free-form layout.final LayoutElementType
The type of element.final String
The type of element.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RenderingRules property.final String
height()
The height of an element within a free-form layout.final LoadingAnimation
The loading animation configuration of a free-form layout element.final List
<SheetElementRenderingRule> The rendering rules that determine when an element should be displayed within a free-form layout.The border style configuration of a free-form layout element.static Class
<? extends FreeFormLayoutElement.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Visibility
The visibility of an element within a free-form layout.final String
The visibility of an element within a free-form layout.final String
width()
The width of an element within a free-form layout.final String
The x-axis coordinate of the element.final String
The y-axis coordinate of the element.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The type of element.
If the service returns an enum value that is not available in the current SDK version,
elementType
will returnLayoutElementType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromelementTypeAsString()
.- Returns:
- The type of element.
- See Also:
-
elementTypeAsString
The type of element.
If the service returns an enum value that is not available in the current SDK version,
elementType
will returnLayoutElementType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromelementTypeAsString()
.- Returns:
- The type of element.
- See Also:
-
xAxisLocation
The x-axis coordinate of the element.
- Returns:
- The x-axis coordinate of the element.
-
yAxisLocation
The y-axis coordinate of the element.
- Returns:
- The y-axis coordinate of the element.
-
width
The width of an element within a free-form layout.
- Returns:
- The width of an element within a free-form layout.
-
height
The height of an element within a free-form layout.
- Returns:
- The height of an element within a free-form layout.
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- The visibility of an element within a free-form layout.
- See Also:
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- The visibility of an element within a free-form layout.
- See Also:
-
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 theisEmpty()
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
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
The border style configuration of a free-form layout element.
- Returns:
- The border style configuration of a free-form layout element.
-
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
The background style configuration of a free-form layout element.
- Returns:
- The background style configuration of a free-form layout element.
-
loadingAnimation
The loading animation configuration of a free-form layout element.
- Returns:
- The loading animation configuration of a free-form layout element.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FreeFormLayoutElement.Builder,
FreeFormLayoutElement> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-