org.uberfire.ext.wires.core.grids.client.widget.layer.pinning.impl

Class DefaultPinnedModeManager

java.lang.Object

org.uberfire.ext.wires.core.grids.client.widget.layer.pinning.impl.DefaultPinnedModeManager

All Implemented Interfaces:

GridPinnedModeManager, IsPinnedModeAware

public class DefaultPinnedModeManager
extends Object
implements GridPinnedModeManager

Default implementation of GridPinnedModeManager that uses animations to enter and/exit "pinned" mode.

Nested Class Summary

Nested classes/interfaces inherited from interface org.uberfire.ext.wires.core.grids.client.widget.layer.pinning.GridPinnedModeManager

GridPinnedModeManager.PinnedContext

Constructor Summary

Constructors

Constructor and Description
DefaultPinnedModeManager(GridLayer gridLayer)

Method Summary

Modifier and Type	Method and Description
void	addOnEnterPinnedModeCommand(com.google.gwt.user.client.Command command)
void	addOnExitPinnedModeCommand(com.google.gwt.user.client.Command command)
protected void	doEnterPinnedMode(com.google.gwt.user.client.Command onStartCommand, GridWidget gridWidget, Set<GridWidget> gridWidgetsToFadeFromView, Set<com.ait.lienzo.client.core.shape.IPrimitive<?>> gridWidgetConnectorsToFadeFromView)
protected void	doExitPinnedMode(com.google.gwt.user.client.Command onCompleteCommand, Set<GridWidget> gridWidgetsToFadeIntoView, Set<com.ait.lienzo.client.core.shape.IPrimitive<?>> gridWidgetConnectorsToFadeIntoView)
void	enterPinnedMode(GridWidget gridWidget, com.google.gwt.user.client.Command onStartCommand) Enters "pinned" mode.
void	exitPinnedMode(com.google.gwt.user.client.Command onCompleteCommand) Exits "pinned" mode.
TransformMediator	getDefaultTransformMediator() Returns the default restriction when in "unpinned" mode.
GridPinnedModeManager.PinnedContext	getPinnedContext() Returns the pinned Context, or null if no GridWidget is pinned.
boolean	isGridPinned() Returns the current state of the View; whether a GridWidget is already "pinned".
void	updatePinnedContext(GridWidget gridWidget) Updates the context to a different GridWidget and related translation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPinnedModeManager

public DefaultPinnedModeManager(GridLayer gridLayer)

Method Detail

enterPinnedMode

public void enterPinnedMode(GridWidget gridWidget,
                            com.google.gwt.user.client.Command onStartCommand)

Description copied from interface: GridPinnedModeManager

Enters "pinned" mode. This has no effect if another GridWidget is already "pinned".

Specified by:

enterPinnedMode in interface GridPinnedModeManager

Parameters:

gridWidget - GridWidget to "pin"

onStartCommand - Command to execute on start of entry to "pinned" mode

doEnterPinnedMode

protected void doEnterPinnedMode(com.google.gwt.user.client.Command onStartCommand,
                                 GridWidget gridWidget,
                                 Set<GridWidget> gridWidgetsToFadeFromView,
                                 Set<com.ait.lienzo.client.core.shape.IPrimitive<?>> gridWidgetConnectorsToFadeFromView)

exitPinnedMode

public void exitPinnedMode(com.google.gwt.user.client.Command onCompleteCommand)

Description copied from interface: GridPinnedModeManager

Exits "pinned" mode. This has no effect if a GridWidget is not already pinned.

Specified by:

exitPinnedMode in interface GridPinnedModeManager

Parameters:

onCompleteCommand - Command to execute on completion of exiting "pinned" mode

doExitPinnedMode

protected void doExitPinnedMode(com.google.gwt.user.client.Command onCompleteCommand,
                                Set<GridWidget> gridWidgetsToFadeIntoView,
                                Set<com.ait.lienzo.client.core.shape.IPrimitive<?>> gridWidgetConnectorsToFadeIntoView)

updatePinnedContext

public void updatePinnedContext(GridWidget gridWidget)
                         throws IllegalStateException

Description copied from interface: GridPinnedModeManager

Updates the context to a different GridWidget and related translation.

Specified by:

updatePinnedContext in interface GridPinnedModeManager

Parameters:

gridWidget - GridWidget to "pin"

Throws:

IllegalStateException - If "pinned" mode has not been entered.

getPinnedContext

public GridPinnedModeManager.PinnedContext getPinnedContext()

Description copied from interface: GridPinnedModeManager

Returns the pinned Context, or null if no GridWidget is pinned.

Specified by:

getPinnedContext in interface GridPinnedModeManager

Returns:

isGridPinned

public boolean isGridPinned()

Description copied from interface: IsPinnedModeAware

Returns the current state of the View; whether a GridWidget is already "pinned".

Specified by:

isGridPinned in interface IsPinnedModeAware

Returns:

getDefaultTransformMediator

public TransformMediator getDefaultTransformMediator()

Description copied from interface: GridPinnedModeManager

Returns the default restriction when in "unpinned" mode.

Specified by:

getDefaultTransformMediator in interface GridPinnedModeManager

Returns:

addOnEnterPinnedModeCommand

public void addOnEnterPinnedModeCommand(com.google.gwt.user.client.Command command)

Specified by:

addOnEnterPinnedModeCommand in interface GridPinnedModeManager

addOnExitPinnedModeCommand

public void addOnExitPinnedModeCommand(com.google.gwt.user.client.Command command)

Specified by:

addOnExitPinnedModeCommand in interface GridPinnedModeManager