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

Class DefaultGridLayer

java.lang.Object

com.ait.lienzo.client.core.shape.Node<T>

com.ait.lienzo.client.core.shape.ContainerNode<com.ait.lienzo.client.core.shape.IPrimitive<?>,com.ait.lienzo.client.core.shape.Layer>

com.ait.lienzo.client.core.shape.Layer

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

All Implemented Interfaces:

com.ait.lienzo.client.core.event.NodeMouseDownHandler, com.ait.lienzo.client.core.event.NodeMouseMoveHandler, com.ait.lienzo.client.core.event.NodeMouseUpHandler, com.ait.lienzo.client.core.shape.IContainer<com.ait.lienzo.client.core.shape.Layer,com.ait.lienzo.client.core.shape.IPrimitive<?>>, com.ait.lienzo.client.core.shape.IDrawable<com.ait.lienzo.client.core.shape.Layer>, com.ait.lienzo.client.core.shape.json.IJSONSerializable<com.ait.lienzo.client.core.shape.Layer>, com.ait.tooling.nativetools.client.NObjectOnWire, com.google.gwt.event.shared.EventHandler, GridLayer, GridSelectionManager, GridWidgetRegistry, GridPinnedModeManager, IsPinnedModeAware

public class DefaultGridLayer
extends com.ait.lienzo.client.core.shape.Layer
implements GridLayer, GridWidgetRegistry

Default implementation of GridLayer

Nested Class Summary

Nested classes/interfaces inherited from class com.ait.lienzo.client.core.shape.Layer

com.ait.lienzo.client.core.shape.Layer.LayerFactory, com.ait.lienzo.client.core.shape.Layer.SelectionLayer

Nested classes/interfaces inherited from class com.ait.lienzo.client.core.shape.ContainerNode

com.ait.lienzo.client.core.shape.ContainerNode.ContainerNodeFactory<C extends com.ait.lienzo.client.core.shape.json.IJSONSerializable<C> & com.ait.lienzo.client.core.shape.IContainer<C,?>>

Nested classes/interfaces inherited from class com.ait.lienzo.client.core.shape.Node

com.ait.lienzo.client.core.shape.Node.NodeFactory<N extends com.ait.lienzo.client.core.shape.json.IJSONSerializable<N>>

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
DefaultGridLayer()

Method Summary

Modifier and Type	Method and Description
com.ait.lienzo.client.core.shape.Layer	add(com.ait.lienzo.client.core.shape.IPrimitive<?> child) Add a child to this Layer.
com.ait.lienzo.client.core.shape.Layer	add(com.ait.lienzo.client.core.shape.IPrimitive<?> child, com.ait.lienzo.client.core.shape.IPrimitive<?>... children) Add a child and other children to this Layer.
void	addOnEnterPinnedModeCommand(com.google.gwt.user.client.Command command)
void	addOnExitPinnedModeCommand(com.google.gwt.user.client.Command command)
com.ait.lienzo.client.core.shape.Layer	batch()
com.ait.lienzo.client.core.shape.Layer	batch(GridLayerRedrawManager.PrioritizedCommand command) Redraw the Grid.
void	deregister(GridWidget gridWidget) Deregisters a GridWidget
com.ait.lienzo.client.core.shape.Layer	draw()
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.
void	flipToGridWidget(GridWidget gridWidget) Moves the specified GridWidget into view without scrolling the Canvas.
TransformMediator	getDefaultTransformMediator() Returns the default restriction when in "unpinned" mode.
com.google.gwt.user.client.ui.AbsolutePanel	getDomElementContainer() Get the overlay panel.
Set<com.ait.lienzo.client.core.shape.IPrimitive<?>>	getGridWidgetConnectors() Gets a collection of all connectors used to connect all GridWidget together.
protected GridWidgetDnDMouseDownHandler	getGridWidgetDnDMouseDownHandler()
protected GridWidgetDnDMouseMoveHandler	getGridWidgetDnDMouseMoveHandler()
protected GridWidgetDnDMouseUpHandler	getGridWidgetDnDMouseUpHandler()
GridWidgetDnDHandlersState	getGridWidgetHandlersState() Get the state of any Handlers registered to the Grid
Set<GridWidget>	getGridWidgets()
GridPinnedModeManager.PinnedContext	getPinnedContext() Returns the pinned Context, or null if no GridWidget is pinned.
Bounds	getVisibleBounds() Get the visible bounds of the Layer in the Viewport
boolean	isGridPinned() Returns the current state of the View; whether a GridWidget is already "pinned".
void	onNodeMouseDown(com.ait.lienzo.client.core.event.NodeMouseDownEvent event)
void	onNodeMouseMove(com.ait.lienzo.client.core.event.NodeMouseMoveEvent event)
void	onNodeMouseUp(com.ait.lienzo.client.core.event.NodeMouseUpEvent event)
void	refreshGridWidgetConnectors() Refreshes all connectors used to connect all GridWidget together.
void	register(GridWidget gridWidget) Registers a GridWidget
com.ait.lienzo.client.core.shape.Layer	remove(com.ait.lienzo.client.core.shape.IPrimitive<?> child) Remove a child from this Layer. if the child is a GridWidget also remove any Connectors that have been added between the GridWidget being removed and any of GridWidgets.
com.ait.lienzo.client.core.shape.Layer	removeAll()
void	scrollToGridWidget(GridWidget gridWidget) Scrolls the specified GridWidget into view.
void	select(GridWidget selectedGridWidget)
void	selectLinkedColumn(GridColumn<?> selectedGridColumn)
void	setDomElementContainer(com.google.gwt.user.client.ui.AbsolutePanel domElementContainer) Set a reference to an AbsolutePanel that overlays the Canvas.
void	updatePinnedContext(GridWidget gridWidget) Updates the context to a different GridWidget and related translation.

Methods inherited from class com.ait.lienzo.client.core.shape.Layer

asLayer, clear, doBatchScheduled, draw, find, findShapeAtPoint, getCanvasElement, getContext, getDefaultStorageEngine, getElement, getHeight, getLayer, getSelectionLayer, getTransformingAttributes, getWidth, isBatchScheduled, isClearLayerBeforeDraw, isSelection, isShowSelectionLayer, isTransformable, moveDown, moveToBottom, moveToTop, moveUp, removeFromParent, setClearLayerBeforeDraw, setListening, setOnLayerAfterDraw, setOnLayerBeforeDraw, setShowSelectionLayer, setTransformable, setVisible, toDataURL, toDataURL, toJSONObject, unBatchScheduled

Methods inherited from class com.ait.lienzo.client.core.shape.ContainerNode

asContainer, asContainerNode, copy, drawWithoutTransforms, find, findByID, getBoundingBox, getBoundingBoxAttributes, getChildNodes, getChildNodes, getPathClipper, getStorageBounds, getStorageEngine, length, moveDown, moveToBottom, moveToTop, moveUp, setPathClipper, setStorageBounds, setStorageEngine

Methods inherited from class com.ait.lienzo.client.core.shape.Node

addAttributesChangedHandler, addEnsureHandler, addNodeDragEndHandler, addNodeDragMoveHandler, addNodeDragStartHandler, addNodeGestureChangeHandler, addNodeGestureEndHandler, addNodeGestureStartHandler, addNodeMouseClickHandler, addNodeMouseDoubleClickHandler, addNodeMouseDownHandler, addNodeMouseEnterHandler, addNodeMouseExitHandler, addNodeMouseMoveHandler, addNodeMouseOutHandler, addNodeMouseOverHandler, addNodeMouseUpHandler, addNodeMouseWheelHandler, addNodeTouchCancelHandler, addNodeTouchEndHandler, addNodeTouchMoveHandler, addNodeTouchStartHandler, addParentsLocations, animate, animate, asAttributes, asAttributes, asGroup, asGroupOf, asGuide, asList, asMultiPointShape, asNode, asPrimitive, asScene, asShape, asViewport, cancelAttributesChangedBatcher, cast, copyUnchecked, doAnimating, drawWithTransforms, drawWithTransforms, equals, fireEvent, getAbsoluteLocation, getAbsoluteTransform, getAttributes, getAttributeSheet, getBoundingPoints, getBoundingPoints, getComputedBoundingPoints, getComputedLocation, getFactory, getID, getMetaData, getName, getNodeType, getOverLayer, getParent, getPossibleNodeTransform, getRequiredAttributes, getScene, getScratchPad, getUserData, getViewport, hashCode, hasMetaData, isAnimating, isEventHandled, isEventHandledGlobally, isListening, isVisible, onWire, refresh, setAttributesChangedBatcher, setID, setName, setNodeType, setParent, setUserData, toJSONString, toString, unAnimating, uuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ait.lienzo.client.core.shape.IContainer

find, findByID, getChildNodes, getChildNodes, getDefaultStorageEngine, getPathClipper, getStorageBounds, getStorageEngine, length, moveDown, moveToBottom, moveToTop, moveUp, setPathClipper, setStorageBounds, setStorageEngine

Methods inherited from interface com.ait.lienzo.client.core.shape.IDrawable

addAttributesChangedHandler, addNodeDragEndHandler, addNodeDragMoveHandler, addNodeDragStartHandler, addNodeGestureChangeHandler, addNodeGestureEndHandler, addNodeGestureStartHandler, addNodeMouseClickHandler, addNodeMouseDoubleClickHandler, addNodeMouseDownHandler, addNodeMouseEnterHandler, addNodeMouseExitHandler, addNodeMouseMoveHandler, addNodeMouseOutHandler, addNodeMouseOverHandler, addNodeMouseUpHandler, addNodeMouseWheelHandler, addNodeTouchCancelHandler, addNodeTouchEndHandler, addNodeTouchMoveHandler, addNodeTouchStartHandler, animate, animate, asContainer, asContainerNode, asGroup, asGroupOf, asGuide, asLayer, asMultiPointShape, asNode, asPrimitive, asScene, asShape, asViewport, cancelAttributesChangedBatcher, copy, drawWithTransforms, fireEvent, getAbsoluteLocation, getAbsoluteTransform, getAttributes, getAttributeSheet, getBoundingBox, getBoundingBoxAttributes, getBoundingPoints, getComputedBoundingPoints, getComputedLocation, getID, getLayer, getMetaData, getName, getNodeType, getOverLayer, getParent, getRequiredAttributes, getScene, getScratchPad, getTransformingAttributes, getUserData, getViewport, hasMetaData, isEventHandled, isListening, isVisible, moveDown, moveToBottom, moveToTop, moveUp, refresh, removeFromParent, setAttributesChangedBatcher, setID, setListening, setName, setUserData, setVisible, uuid

Methods inherited from interface com.ait.tooling.nativetools.client.NObjectOnWire

onWire

Methods inherited from interface com.ait.lienzo.client.core.shape.json.IJSONSerializable

getFactory, toJSONObject, toJSONString

Constructor Detail

DefaultGridLayer

public DefaultGridLayer()

Method Detail

getGridWidgetDnDMouseDownHandler

protected GridWidgetDnDMouseDownHandler getGridWidgetDnDMouseDownHandler()

getGridWidgetDnDMouseMoveHandler

protected GridWidgetDnDMouseMoveHandler getGridWidgetDnDMouseMoveHandler()

getGridWidgetDnDMouseUpHandler

protected GridWidgetDnDMouseUpHandler getGridWidgetDnDMouseUpHandler()

onNodeMouseDown

public void onNodeMouseDown(com.ait.lienzo.client.core.event.NodeMouseDownEvent event)

Specified by:

onNodeMouseDown in interface com.ait.lienzo.client.core.event.NodeMouseDownHandler

onNodeMouseMove

public void onNodeMouseMove(com.ait.lienzo.client.core.event.NodeMouseMoveEvent event)

Specified by:

onNodeMouseMove in interface com.ait.lienzo.client.core.event.NodeMouseMoveHandler

onNodeMouseUp

public void onNodeMouseUp(com.ait.lienzo.client.core.event.NodeMouseUpEvent event)

Specified by:

onNodeMouseUp in interface com.ait.lienzo.client.core.event.NodeMouseUpHandler

draw

public com.ait.lienzo.client.core.shape.Layer draw()

Specified by:

draw in interface com.ait.lienzo.client.core.shape.IDrawable<com.ait.lienzo.client.core.shape.Layer>

Overrides:

draw in class com.ait.lienzo.client.core.shape.Layer

batch

public com.ait.lienzo.client.core.shape.Layer batch()

Specified by:

batch in interface com.ait.lienzo.client.core.shape.IDrawable<com.ait.lienzo.client.core.shape.Layer>

Overrides:

batch in class com.ait.lienzo.client.core.shape.Layer

batch

public com.ait.lienzo.client.core.shape.Layer batch(GridLayerRedrawManager.PrioritizedCommand command)

Description copied from interface: GridLayer

Redraw the Grid. All updates are batched into a single draw on the next animation frame. Execute the provided command after the batch redraw has been scheduled.

Specified by:

batch in interface GridLayer

Parameters:

command - The command to execute

Returns:

getGridWidgetConnectors

public Set<com.ait.lienzo.client.core.shape.IPrimitive<?>> getGridWidgetConnectors()

Description copied from interface: GridLayer

Gets a collection of all connectors used to connect all GridWidget together.

Specified by:

getGridWidgetConnectors in interface GridLayer

Returns:

A Set of connectors.

add

public com.ait.lienzo.client.core.shape.Layer add(com.ait.lienzo.client.core.shape.IPrimitive<?> child)

Add a child to this Layer. If the child is a GridWidget then also add a Connector between the Grid Widget and any "linked" GridWidgets.

Specified by:

add in interface com.ait.lienzo.client.core.shape.IContainer<com.ait.lienzo.client.core.shape.Layer,com.ait.lienzo.client.core.shape.IPrimitive<?>>

Overrides:

add in class com.ait.lienzo.client.core.shape.Layer

Parameters:

child - Primitive to add to the Layer

Returns:

The Layer

register

public void register(GridWidget gridWidget)

Description copied from interface: GridWidgetRegistry

Registers a GridWidget

Specified by:

register in interface GridWidgetRegistry

Parameters:

gridWidget - The GridWidget to register

refreshGridWidgetConnectors

public void refreshGridWidgetConnectors()

Description copied from interface: GridLayer

Refreshes all connectors used to connect all GridWidget together.

Specified by:

refreshGridWidgetConnectors in interface GridLayer

add

public com.ait.lienzo.client.core.shape.Layer add(com.ait.lienzo.client.core.shape.IPrimitive<?> child,
                                                  com.ait.lienzo.client.core.shape.IPrimitive<?>... children)

Add a child and other children to this Layer. If the child or any children is a GridWidget then also add a Connector between the Grid Widget and any "linked" GridWidgets.

Specified by:

add in interface com.ait.lienzo.client.core.shape.IContainer<com.ait.lienzo.client.core.shape.Layer,com.ait.lienzo.client.core.shape.IPrimitive<?>>

Overrides:

add in class com.ait.lienzo.client.core.shape.Layer

Parameters:

child - Primitive to add to the Layer

children - Additional primitive(s) to add to the Layer

Returns:

The Layer

remove

public com.ait.lienzo.client.core.shape.Layer remove(com.ait.lienzo.client.core.shape.IPrimitive<?> child)

Remove a child from this Layer. if the child is a GridWidget also remove any Connectors that have been added between the GridWidget being removed and any of GridWidgets.

Specified by:

remove in interface com.ait.lienzo.client.core.shape.IContainer<com.ait.lienzo.client.core.shape.Layer,com.ait.lienzo.client.core.shape.IPrimitive<?>>

Overrides:

remove in class com.ait.lienzo.client.core.shape.Layer

Parameters:

child - Primitive to remove from the Layer

Returns:

The Layer

deregister

public void deregister(GridWidget gridWidget)

Description copied from interface: GridWidgetRegistry

Deregisters a GridWidget

Specified by:

deregister in interface GridWidgetRegistry

Parameters:

gridWidget - The GridWidget to deregister

removeAll

public com.ait.lienzo.client.core.shape.Layer removeAll()

Specified by:

removeAll in interface com.ait.lienzo.client.core.shape.IContainer<com.ait.lienzo.client.core.shape.Layer,com.ait.lienzo.client.core.shape.IPrimitive<?>>

Overrides:

removeAll in class com.ait.lienzo.client.core.shape.Layer

select

public void select(GridWidget selectedGridWidget)

Specified by:

select in interface GridSelectionManager

selectLinkedColumn

public void selectLinkedColumn(GridColumn<?> selectedGridColumn)

Specified by:

selectLinkedColumn in interface GridSelectionManager

flipToGridWidget

public void flipToGridWidget(GridWidget gridWidget)

Description copied from interface: GridLayer

Moves the specified GridWidget into view without scrolling the Canvas. If the GridLayer is not in "pinned mode" this method has no operation.

Specified by:

flipToGridWidget in interface GridLayer

Parameters:

gridWidget - The GridWidget to move into view.

scrollToGridWidget

public void scrollToGridWidget(GridWidget gridWidget)

Description copied from interface: GridLayer

Scrolls the specified GridWidget into view. If the GridLayer is in "pinned mode" this method has no operation.

Specified by:

scrollToGridWidget in interface GridLayer

Parameters:

gridWidget - The GridWidget to scroll into view.

getGridWidgets

public Set<GridWidget> getGridWidgets()

Specified by:

getGridWidgets in interface GridSelectionManager

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

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

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

getVisibleBounds

public Bounds getVisibleBounds()

Description copied from interface: GridLayer

Get the visible bounds of the Layer in the Viewport

Specified by:

getVisibleBounds in interface GridLayer

Returns:

getGridWidgetHandlersState

public GridWidgetDnDHandlersState getGridWidgetHandlersState()

Description copied from interface: GridLayer

Get the state of any Handlers registered to the Grid

Specified by:

getGridWidgetHandlersState in interface GridLayer

Returns:

getDomElementContainer

public com.google.gwt.user.client.ui.AbsolutePanel getDomElementContainer()

Description copied from interface: GridLayer

Get the overlay panel.

Specified by:

getDomElementContainer in interface GridLayer

Returns:

setDomElementContainer

public void setDomElementContainer(com.google.gwt.user.client.ui.AbsolutePanel domElementContainer)

Description copied from interface: GridLayer

Set a reference to an AbsolutePanel that overlays the Canvas. This can be used to overlay DOM elements on top of the Canvas.

Specified by:

setDomElementContainer in interface GridLayer

Parameters:

domElementContainer - The overlay panel