Package com.vaadin.flow.router

Class HighlightActions

java.lang.Object

com.vaadin.flow.router.HighlightActions

public final class HighlightActions
extends Object

A set of predefined HighlightActions.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static <C extends HasElement> HighlightAction<C>	none()	An action which does nothing, regardless of the highlight state.
static <C extends HasElement> HighlightAction<C>	toggleAttribute(String attribute)	An action which toggles the target's attribute based on its highlight state.
static <C extends HasStyle> HighlightAction<C>	toggleClassName(String className)	An action which toggles className class on the target based on its highlight state.
static <C extends HasElement> HighlightAction<C>	toggleTheme(String theme)	An action which toggles theme on the target based on its highlight state.

Methods inherited from class java.lang.Object

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

Method Details

toggleClassName

public static <C extends HasStyle>
HighlightAction<C> toggleClassName(String className)

An action which toggles className class on the target based on its highlight state.

Type Parameters:

C - the target type

Parameters:

className - the class name to toggle

Returns:

the highlight action

toggleTheme

public static <C extends HasElement>
HighlightAction<C> toggleTheme(String theme)

An action which toggles theme on the target based on its highlight state.

Type Parameters:

C - the target type

Parameters:

theme - the theme to toggle

Returns:

the highlight action

toggleAttribute

public static <C extends HasElement>
HighlightAction<C> toggleAttribute(String attribute)

An action which toggles the target's attribute based on its highlight state.

Type Parameters:

C - the target type

Parameters:

attribute - the attribute to toggle

Returns:

the highlight action

none

public static <C extends HasElement>
HighlightAction<C> none()

An action which does nothing, regardless of the highlight state.

Type Parameters:

C - the target type

Returns:

the highlight action