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

Interface GridWidget

All Superinterfaces:

CellSelectionManager, com.google.gwt.event.shared.EventHandler, com.ait.lienzo.client.core.shape.wires.IControlHandleFactory, com.ait.lienzo.client.core.shape.IDrawable<com.ait.lienzo.client.core.shape.Group>, com.ait.lienzo.client.core.shape.json.IJSONSerializable<com.ait.lienzo.client.core.shape.Group>, com.ait.lienzo.client.core.shape.IPrimitive<com.ait.lienzo.client.core.shape.Group>, com.ait.tooling.nativetools.client.NObjectOnWire, com.ait.lienzo.client.core.event.NodeMouseClickHandler

All Known Implementing Classes:

BaseGridWidget

public interface GridWidget
extends com.ait.lienzo.client.core.shape.IPrimitive<com.ait.lienzo.client.core.shape.Group>, com.ait.lienzo.client.core.event.NodeMouseClickHandler, CellSelectionManager

The base of all GridWidgets.

Method Summary

Modifier and Type	Method and Description
void	deselect() Deselects the Widget; i.e. another GridWidget has been clicked on, so hide any visual indicator that this Widget was selected.
com.ait.lienzo.client.core.shape.Group	getBody() Returns the Group representing the GridWidget's Body
CellSelectionManager	getCellSelectionManager() Returns the CellSelectionManager associated with the GridWidget
com.ait.lienzo.client.core.shape.Group	getHeader() Returns the Group representing the GridWidget's Header
double	getHeight() Returns the height of the whole Widget, including Header and Body.
GridData	getModel() Returns the Model backing the Widget.
GridRenderer	getRenderer() Returns the Renderer used to render the Widget.
BaseGridRendererHelper	getRendererHelper() Returns helper for rendering the Widget.
double	getWidth() Returns the width of the whole Widget.
boolean	isSelected() Returns the selected state of the Widget.
default boolean	onDragHandle(com.ait.lienzo.client.core.event.INodeXYEvent event) Checks whether a canvas coordinate is within the "drag handle" for the GridWidget.
boolean	onGroupingToggle(double cellX, double cellY, double cellWidth, double cellHeight) Checks whether a cell-relative coordinate is "on" the hot-spot to toggle the collapsed/expanded state.
void	select() Selects the Widget; i.e. it has been clicked on, so show some visual indicator that it has been selected.
void	setRenderer(GridRenderer renderer) Returns the Rendered used to render the Widget.
boolean	showContextMenuForCell(int uiRowIndex, int uiColumnIndex) Show context menu of a cell at coordinates 'uiRowIndex' and 'uiColumnIndex'.
boolean	showContextMenuForHeader(int uiHeaderRowIndex, int uiHeaderColumnIndex) Show context menu of a header cell at coordinates 'uiHeaderRowIndex' and 'uiHeaderColumnIndex'.

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

attachToLayerColorMap, detachFromLayerColorMap, getAlpha, getControlHandleFactory, getDragBounds, getDragConstraint, getDragConstraints, getDragMode, getEventPropagationMode, getFillAlpha, getLocation, getOffset, getRotation, getRotationDegrees, getScale, getShear, getStrokeAlpha, getX, getY, isDraggable, isDragging, isEditable, setAlpha, setControlHandleFactory, setDragBounds, setDragConstraint, setDragConstraints, setDraggable, setDragging, setDragMode, setEditable, setEventPropagationMode, setFillAlpha, setLocation, setOffset, setOffset, setOffset, setRotation, setRotationDegrees, setScale, setScale, setScale, setShear, setShear, setStrokeAlpha, setX, setY

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.shape.wires.IControlHandleFactory

getControlHandles, getControlHandles

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

onNodeMouseClick

Methods inherited from interface org.uberfire.ext.wires.core.grids.client.widget.grid.selections.CellSelectionManager

adjustSelection, selectCell, selectCell, selectHeaderCell, selectHeaderCell, startEditingCell, startEditingCell

Method Detail

getModel

GridData getModel()

Returns the Model backing the Widget.

Returns:

getRenderer

GridRenderer getRenderer()

Returns the Renderer used to render the Widget.

Returns:

setRenderer

void setRenderer(GridRenderer renderer)

Returns the Rendered used to render the Widget.

Parameters:

renderer -

getRendererHelper

BaseGridRendererHelper getRendererHelper()

Returns helper for rendering the Widget.

Returns:

getBody

com.ait.lienzo.client.core.shape.Group getBody()

Returns the Group representing the GridWidget's Body

Returns:

getHeader

com.ait.lienzo.client.core.shape.Group getHeader()

Returns the Group representing the GridWidget's Header

Returns:

getWidth

double getWidth()

Returns the width of the whole Widget.

Returns:

getHeight

double getHeight()

Returns the height of the whole Widget, including Header and Body.

Returns:

select

void select()

Selects the Widget; i.e. it has been clicked on, so show some visual indicator that it has been selected.

deselect

void deselect()

Deselects the Widget; i.e. another GridWidget has been clicked on, so hide any visual indicator that this Widget was selected.

isSelected

boolean isSelected()

Returns the selected state of the Widget.

Returns:

true if the Widget is selected.

showContextMenuForHeader

boolean showContextMenuForHeader(int uiHeaderRowIndex,
                                 int uiHeaderColumnIndex)

Show context menu of a header cell at coordinates 'uiHeaderRowIndex' and 'uiHeaderColumnIndex'. If the provided coordinate does not resolve to a header cell in the Grid no operation is performed.

Parameters:

uiHeaderRowIndex - Header row index of cell to invoke context menu

uiHeaderColumnIndex - Header column index of cell to invoke context menu

Returns:

true if menu was shown.

showContextMenuForCell

boolean showContextMenuForCell(int uiRowIndex,
                               int uiColumnIndex)

Show context menu of a cell at coordinates 'uiRowIndex' and 'uiColumnIndex'. If the provided coordinate does not resolve to a cell in the Grid no operation is performed.

Parameters:

uiRowIndex - Row index of cell to invoke context menu

uiColumnIndex - Column index of cell to invoke context menu

Returns:

true if menu was shown.

getCellSelectionManager

CellSelectionManager getCellSelectionManager()

Returns the CellSelectionManager associated with the GridWidget

Returns:

onGroupingToggle

boolean onGroupingToggle(double cellX,
                         double cellY,
                         double cellWidth,
                         double cellHeight)

Checks whether a cell-relative coordinate is "on" the hot-spot to toggle the collapsed/expanded state.

Parameters:

cellX - The MouseEvent relative to the cell's x-coordinate.

cellY - The MouseEvent relative to the cell's y-coordinate.

cellWidth - Width of the containing cell.

cellHeight - Height of the containing cell.

Returns:

true if the cell coordinate is on the hot-spot.

onDragHandle

default boolean onDragHandle(com.ait.lienzo.client.core.event.INodeXYEvent event)

Checks whether a canvas coordinate is within the "drag handle" for the GridWidget. Canvas coordinates can be mapped to coordinates relative to the GridWidget with CoordinateUtilities.convertDOMToGridCoordinate(GridWidget, Point2D)

Parameters:

event - The INodeXYEvent relative to the canvas coordinate system.

Returns:

true if the event is within the drag handle.