DepthLevels

public final class DepthLevels

Glimmer components can use Depth to establish a sense of hierarchy. DepthLevels contains different levels of Depth to express this hierarchy. Higher levels contain larger shadows, and represent components with a higher z-order than lower levels. In their baseline state (not focused) most components should have no (null) Depth.

See also
Depth
depth

Summary

Public constructors
DepthLevels(
    @NonNull Depth level1,
    @NonNull Depth level2,
    @NonNull Depth level3,
    @NonNull Depth level4,
    @NonNull Depth level5
)

Public methods
boolean
equals(Object other)
final @NonNull Depth

the lowest level of Depth.
final @NonNull Depth

a level of Depth higher than level1 and lower than level3.
final @NonNull Depth

a level of Depth higher than level2 and lower than level4.
final @NonNull Depth

a level of Depth higher than level3 and lower than level5.
final @NonNull Depth

the highest level of Depth.
int
@NonNull String

Public constructors

DepthLevels

Added in 1.0.0-alpha01
public DepthLevels(
    @NonNull Depth level1,
    @NonNull Depth level2,
    @NonNull Depth level3,
    @NonNull Depth level4,
    @NonNull Depth level5
)

Public methods

equals

public boolean equals(Object other)

getLevel1

Added in 1.0.0-alpha01
public final @NonNull Depth getLevel1()

the lowest level of Depth. This level will have the smallest shadows.

getLevel2

Added in 1.0.0-alpha01
public final @NonNull Depth getLevel2()

a level of Depth higher than level1 and lower than level3.

getLevel3

Added in 1.0.0-alpha01
public final @NonNull Depth getLevel3()

a level of Depth higher than level2 and lower than level4.

getLevel4

Added in 1.0.0-alpha01
public final @NonNull Depth getLevel4()

a level of Depth higher than level3 and lower than level5.

getLevel5

Added in 1.0.0-alpha01
public final @NonNull Depth getLevel5()

the highest level of Depth. This level will have the largest shadows.

hashCode

public int hashCode()

toString

public @NonNull String toString()