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

Interface GridLayer

All Superinterfaces:

com.google.gwt.event.shared.EventHandler, GridPinnedModeManager, GridSelectionManager, 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>, IsPinnedModeAware, com.ait.tooling.nativetools.client.NObjectOnWire, com.ait.lienzo.client.core.event.NodeMouseDownHandler, com.ait.lienzo.client.core.event.NodeMouseMoveHandler, com.ait.lienzo.client.core.event.NodeMouseUpHandler

All Known Implementing Classes:

DefaultGridLayer

public interface GridLayer
extends GridSelectionManager, GridPinnedModeManager, 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.event.NodeMouseDownHandler, com.ait.lienzo.client.core.event.NodeMouseMoveHandler, com.ait.lienzo.client.core.event.NodeMouseUpHandler

A specialised Layer that supports pass-through of MouseEvents from DOMElements to GridWidgets. This implementation handles drawing connectors between "linked" grids and acts as a GridSelectionManager.

Nested Class Summary

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

GridPinnedModeManager.PinnedContext

Method Summary

Modifier and Type	Method and Description
com.ait.lienzo.client.core.shape.Layer	batch(GridLayerRedrawManager.PrioritizedCommand command) Redraw the Grid.
void	flipToGridWidget(GridWidget gridWidget) Moves the specified GridWidget into view without scrolling the Canvas.
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.
GridWidgetDnDHandlersState	getGridWidgetHandlersState() Get the state of any Handlers registered to the Grid
Bounds	getVisibleBounds() Get the visible bounds of the Layer in the Viewport
void	refreshGridWidgetConnectors() Refreshes all connectors used to connect all GridWidget together.
void	scrollToGridWidget(GridWidget gridWidget) Scrolls the specified GridWidget into view.
void	setDomElementContainer(com.google.gwt.user.client.ui.AbsolutePanel getDomElementContainer) Set a reference to an AbsolutePanel that overlays the Canvas.

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.widget.layer.GridSelectionManager

getGridWidgets, select, selectLinkedColumn

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.widget.layer.pinning.GridPinnedModeManager

addOnEnterPinnedModeCommand, addOnExitPinnedModeCommand, enterPinnedMode, exitPinnedMode, getDefaultTransformMediator, getPinnedContext, updatePinnedContext

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.widget.layer.pinning.IsPinnedModeAware

isGridPinned

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

add, add, find, findByID, getChildNodes, getChildNodes, getDefaultStorageEngine, getPathClipper, getStorageBounds, getStorageEngine, length, moveDown, moveToBottom, moveToTop, moveUp, remove, removeAll, 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, batch, cancelAttributesChangedBatcher, copy, draw, 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

Methods inherited from interface com.ait.lienzo.client.core.event.NodeMouseDownHandler

onNodeMouseDown

Methods inherited from interface com.ait.lienzo.client.core.event.NodeMouseMoveHandler

onNodeMouseMove

Methods inherited from interface com.ait.lienzo.client.core.event.NodeMouseUpHandler

onNodeMouseUp

Method Detail

getVisibleBounds

Bounds getVisibleBounds()

Get the visible bounds of the Layer in the Viewport

Returns:

getGridWidgetHandlersState

GridWidgetDnDHandlersState getGridWidgetHandlersState()

Get the state of any Handlers registered to the Grid

Returns:

getDomElementContainer

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

Get the overlay panel.

Returns:

setDomElementContainer

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

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

Parameters:

getDomElementContainer - The overlay panel

batch

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

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.

Parameters:

command - The command to execute

Returns:

getGridWidgetConnectors

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

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

Returns:

A Set of connectors.

refreshGridWidgetConnectors

void refreshGridWidgetConnectors()

Refreshes all connectors used to connect all GridWidget together.

flipToGridWidget

void flipToGridWidget(GridWidget gridWidget)

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

Parameters:

gridWidget - The GridWidget to move into view.

scrollToGridWidget

void scrollToGridWidget(GridWidget gridWidget)

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

Parameters:

gridWidget - The GridWidget to scroll into view.