org.dominokit.domino.ui.style

Class WavesSupport

java.lang.Object

org.dominokit.domino.ui.style.WavesSupport

All Implemented Interfaces:

HasWaveEffect<WavesSupport>

public class WavesSupport
extends Object
implements HasWaveEffect<WavesSupport>

A utility class for configuring waves for a specific element

Method Summary

Modifier and Type	Method and Description
static WavesSupport	addFor(HasWavesElement element) Adds waves support for a specific element
static WavesSupport	addFor(elemental2.dom.HTMLElement element) Adds waves support for a specific element
WavesSupport	applyWaveStyle(WaveStyle waveStyle) Applies the waves style
WavesSupport	initWaves() Initializes the waves functionality
WavesSupport	removeWaves() Removes the waves support
WavesSupport	setWaveColor(WaveColor waveColor) Sets the color of the waves
WavesSupport	setWavesColor(WaveColor waveColor) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addFor

public static WavesSupport addFor(HasWavesElement element)

Adds waves support for a specific element

Parameters:

element - the HasWavesElement

Returns:

new instance

addFor

public static WavesSupport addFor(elemental2.dom.HTMLElement element)

Adds waves support for a specific element

Parameters:

element - the HTMLElement

Returns:

new instance

initWaves

public WavesSupport initWaves()

Initializes the waves functionality

Specified by:

initWaves in interface HasWaveEffect<WavesSupport>

Returns:

same instance

setWavesColor

@Deprecated
public WavesSupport setWavesColor(WaveColor waveColor)

Deprecated.

Use setWaveColor(WaveColor) instead

setWaveColor

public WavesSupport setWaveColor(WaveColor waveColor)

Sets the color of the waves

Specified by:

setWaveColor in interface HasWaveEffect<WavesSupport>

Parameters:

waveColor - the WaveColor

Returns:

same instance

applyWaveStyle

public WavesSupport applyWaveStyle(WaveStyle waveStyle)

Applies the waves style

Specified by:

applyWaveStyle in interface HasWaveEffect<WavesSupport>

Parameters:

waveStyle - the WaveStyle

Returns:

same instance

removeWaves

public WavesSupport removeWaves()

Removes the waves support

Specified by:

removeWaves in interface HasWaveEffect<WavesSupport>

Returns:

same instance