Package org.vaadin.addons.componentfactory.sidenavrail

Class RailModeChangedEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<SideNavRail>

org.vaadin.addons.componentfactory.sidenavrail.RailModeChangedEvent

All Implemented Interfaces:

Serializable

public class RailModeChangedEvent
extends com.vaadin.flow.component.ComponentEvent<SideNavRail>

Fired when SideNavRail.setRailMode(boolean) actually changes the rail-mode state. No-op calls (same value) do not fire. Register via SideNavRail.addRailModeChangedListener(com.vaadin.flow.component.ComponentEventListener<org.vaadin.addons.componentfactory.sidenavrail.RailModeChangedEvent>).

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
RailModeChangedEvent(SideNavRail source, boolean fromClient, boolean railMode)

Method Summary

Modifier and Type	Method	Description
boolean	isRailMode()	The new rail-mode value after the change.

Methods inherited from class com.vaadin.flow.component.ComponentEvent

getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Details

RailModeChangedEvent

public RailModeChangedEvent(SideNavRail source,
 boolean fromClient,
 boolean railMode)

Parameters:

source - the nav that changed state

fromClient - whether the change originated on the client (currently always false since the mode is only driven server-side)

railMode - the new rail-mode value

Method Details

isRailMode

public boolean isRailMode()

The new rail-mode value after the change.

Returns:

true if the rail just switched into rail mode, false if it switched back to normal mode