DrawComponent (GXT 3.1.4)

java.lang.Object
- Widget
- - com.sencha.gxt.widget.core.client.Component
  - - com.sencha.gxt.chart.client.draw.DrawComponent

All Implemented Interfaces:

SpriteHandler.HasSpriteHandlers, SpriteOutEvent.HasSpriteOutHandlers, SpriteOverEvent.HasSpriteOverHandlers, SpriteSelectionEvent.HasSpriteSelectionHandlers, SpriteUpEvent.HasSpriteUpHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

Chart
```
public class DrawComponent
extends Component
implements SpriteHandler.HasSpriteHandlers, SpriteOutEvent.HasSpriteOutHandlers, SpriteOverEvent.HasSpriteOverHandlers, SpriteSelectionEvent.HasSpriteSelectionHandlers, SpriteUpEvent.HasSpriteUpHandlers
```
The Draw Component is a surface in which Sprites can be rendered. The Draw Component manages and holds a Surface instance: an interface that has an SVG or VML implementation depending on the browser capabilities and where Sprites can be appended.
Here is an example of creating a draw component:
```
 DrawComponent component = new DrawComponent();
 CircleSprite circle = new CircleSprite();
 circle.setCenterX(120);
 circle.setCenterY(100);
 circle.setRadius(25);
 circle.setFill(RGB.GREEN);
 circle.setStroke(new RGB(#999));
 component.add(circle);

 ContentPanel panel = new ContentPanel();
 panel.setHeadingText("Basic Draw");
 panel.setPixelSize(320, 300);
 panel.add(component);
 
```
The type of the sprite is a CircleSprite so if you run this code you'll see a green circle with gray stroke in a ContentPanel.

Field Summary

Fields
Modifier and Type Field and Description

protected Surface surface
- Fields inherited from class com.sencha.gxt.widget.core.client.Component
  adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Fields
Modifier and Type	Field and Description
`protected Surface`	`surface`

Constructor Summary

Constructors
Constructor and Description
`DrawComponent()` Creates a draw widget at the default size.
`DrawComponent(int width, int height)` Creates a draw widget using the given width and height.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGradient(Gradient gradient)` Adds a `Gradient` to the draw widget's `Surface`.
`void`	`addSprite(Sprite sprite)` Adds a `Sprite` to the draw widget's `Surface`.
`HandlerRegistration`	`addSpriteHandler(SpriteHandler handler)` Adds a `SpriteHandler` handler for `SpriteSelectionEvent`, `SpriteOutEvent`, `SpriteOverEvent` and `SpriteUpEvent` events.
`HandlerRegistration`	`addSpriteOutHandler(SpriteOutEvent.SpriteOutHandler handler)` Adds a `SpriteOutEvent.SpriteOutHandler` handler for `SpriteOutEvent` events.
`HandlerRegistration`	`addSpriteOverHandler(SpriteOverEvent.SpriteOverHandler handler)` Adds a `SpriteOverEvent.SpriteOverHandler` handler for `SpriteOverEvent` events.
`HandlerRegistration`	`addSpriteSelectionHandler(SpriteSelectionEvent.SpriteSelectionHandler handler)` Adds a `SpriteSelectionEvent.SpriteSelectionHandler` handler for `SpriteSelectionEvent` events.
`HandlerRegistration`	`addSpriteUpHandler(SpriteUpEvent.SpriteUpHandler handler)` Adds a `SpriteUpEvent.SpriteUpHandler` handler for `SpriteUpEvent` events.
`void`	`clearSurface()` Clears all of the sprites from the draw surface.
`protected HandlerManager`	`ensureHandler()`
`Color`	`getBackground()` Returns the background color of the component.
`protected PrecisePoint`	`getEventXY(Event event)` Returns the point of the event adjusted for the position of the chart.
`Surface`	`getSurface()` Returns the `Surface`.
`boolean`	`isViewBox()` Returns true if the widget is to have a view box.
`protected void`	`onAttach()`
`void`	`onBrowserEvent(Event event)`
`void`	`onMouseDown(Event event)` Method used when the chart is clicked.
`void`	`onMouseMove(Event event)` Method used when the mouse moves over the chart.
`void`	`onMouseOut(Event event)` Method used when the mouse leaves the chart.
`void`	`onMouseUp(Event event)` Method used when the mouse is released over the chart.
`protected void`	`onResize(int width, int height)` Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
`void`	`redrawSurface()` Calls the `Surface` to render.
`void`	`redrawSurfaceForced()` Redraws the surface immediately.
`void`	`remove(Sprite sprite)` Removes a `Sprite` from the draw widget's `Surface`.
`void`	`renderSprite(Sprite sprite)` Renders the given sprite to the surface.
`void`	`setBackground(Color background)` Sets the background color of the chart.
`void`	`setPixelSize(int width, int height)` Sets the component's size.
`void`	`setViewBox(boolean viewBox)` Sets whether the `Surface` has a view box.

Methods inherited from class com.sencha.gxt.widget.core.client.Component
addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onBlur, onDetach, onDisable, onEnable, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - surface
```
protected Surface surface
```
- Constructor Detail
  - DrawComponent
```
public DrawComponent()
```
    Creates a draw widget at the default size.
  - DrawComponent
```
public DrawComponent(int width,
                     int height)
```
    Creates a draw widget using the given width and height.
    
    Parameters:
    
    width - the width of the draw widget
    
    height - the height of the draw widget
- Method Detail
  - addGradient
```
public void addGradient(Gradient gradient)
```
    Adds a Gradient to the draw widget's Surface.
    
    Parameters:
    
    gradient - the gradient to be added
  - addSprite
```
public void addSprite(Sprite sprite)
```
    Adds a Sprite to the draw widget's Surface.
    
    Parameters:
    
    sprite - the sprite to be added
  - addSpriteHandler
```
public HandlerRegistration addSpriteHandler(SpriteHandler handler)
```
    Description copied from interface: SpriteHandler.HasSpriteHandlers
    
    Adds a SpriteHandler handler for SpriteSelectionEvent, SpriteOutEvent, SpriteOverEvent and SpriteUpEvent events.
    
    Specified by:
    
    addSpriteHandler in interface SpriteHandler.HasSpriteHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addSpriteOutHandler
```
public HandlerRegistration addSpriteOutHandler(SpriteOutEvent.SpriteOutHandler handler)
```
    Description copied from interface: SpriteOutEvent.HasSpriteOutHandlers
    
    Adds a SpriteOutEvent.SpriteOutHandler handler for SpriteOutEvent events.
    
    Specified by:
    
    addSpriteOutHandler in interface SpriteOutEvent.HasSpriteOutHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addSpriteOverHandler
```
public HandlerRegistration addSpriteOverHandler(SpriteOverEvent.SpriteOverHandler handler)
```
    Description copied from interface: SpriteOverEvent.HasSpriteOverHandlers
    
    Adds a SpriteOverEvent.SpriteOverHandler handler for SpriteOverEvent events.
    
    Specified by:
    
    addSpriteOverHandler in interface SpriteOverEvent.HasSpriteOverHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addSpriteSelectionHandler
```
public HandlerRegistration addSpriteSelectionHandler(SpriteSelectionEvent.SpriteSelectionHandler handler)
```
    Description copied from interface: SpriteSelectionEvent.HasSpriteSelectionHandlers
    
    Adds a SpriteSelectionEvent.SpriteSelectionHandler handler for SpriteSelectionEvent events.
    
    Specified by:
    
    addSpriteSelectionHandler in interface SpriteSelectionEvent.HasSpriteSelectionHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - addSpriteUpHandler
```
public HandlerRegistration addSpriteUpHandler(SpriteUpEvent.SpriteUpHandler handler)
```
    Description copied from interface: SpriteUpEvent.HasSpriteUpHandlers
    
    Adds a SpriteUpEvent.SpriteUpHandler handler for SpriteUpEvent events.
    
    Specified by:
    
    addSpriteUpHandler in interface SpriteUpEvent.HasSpriteUpHandlers
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    the registration for the event
  - clearSurface
```
public void clearSurface()
```
    Clears all of the sprites from the draw surface.
  - getBackground
```
public Color getBackground()
```
    Returns the background color of the component.
    
    Returns:
    
    the background color of the component
  - getSurface
```
public Surface getSurface()
```
    Returns the Surface.
    
    Returns:
    
    the surface
  - isViewBox
```
public boolean isViewBox()
```
    Returns true if the widget is to have a view box.
    
    Returns:
    
    true if the widget is to have a view box
  - onBrowserEvent
```
public void onBrowserEvent(Event event)
```
    Overrides:
    
    onBrowserEvent in class Component
  - onMouseDown
```
public void onMouseDown(Event event)
```
    Method used when the chart is clicked.
    
    Parameters:
    
    event - the mouse event
  - onMouseMove
```
public void onMouseMove(Event event)
```
    Method used when the mouse moves over the chart.
    
    Parameters:
    
    event - the mouse event
  - onMouseOut
```
public void onMouseOut(Event event)
```
    Method used when the mouse leaves the chart.
    
    Parameters:
    
    event - the mouse event
  - onMouseUp
```
public void onMouseUp(Event event)
```
    Method used when the mouse is released over the chart.
    
    Parameters:
    
    event - the mouse event
  - redrawSurface
```
public void redrawSurface()
```
    Calls the Surface to render.
  - redrawSurfaceForced
```
public void redrawSurfaceForced()
```
    Redraws the surface immediately.
  - remove
```
public void remove(Sprite sprite)
```
    Removes a Sprite from the draw widget's Surface.
    
    Parameters:
    
    sprite - the sprite to be removed
  - renderSprite
```
public void renderSprite(Sprite sprite)
```
    Renders the given sprite to the surface.
    
    Parameters:
    
    sprite - the sprite to be rendered
  - setBackground
```
public void setBackground(Color background)
```
    Sets the background color of the chart. If set to Color.NONE there will be no background color.
    
    Parameters:
    
    background - the background color of the chart
  - setPixelSize
```
public void setPixelSize(int width,
                         int height)
```
    Description copied from class: Component
    
    Sets the component's size. Unlike GWT widget's, when setting sizes, the component's actual size will match exactly the size specified independent of borders and padding.
    
    Overrides:
    
    setPixelSize in class Component
    
    Parameters:
    
    width - new width, in pixels
    
    height - height, in pixels
  - setViewBox
```
public void setViewBox(boolean viewBox)
```
    Sets whether the Surface has a view box. The view box is determined by the bounding box of all the Sprites in the surface.
    
    Parameters:
    
    viewBox - true for the surface to have a view box
  - ensureHandler
```
protected HandlerManager ensureHandler()
```
  - getEventXY
```
protected PrecisePoint getEventXY(Event event)
```
    Returns the point of the event adjusted for the position of the chart.
    
    Parameters:
    
    event - the event
    
    Returns:
    
    the adjusted point
  - onAttach
```
protected void onAttach()
```
    Overrides:
    
    onAttach in class Component
  - onResize
```
protected void onResize(int width,
                        int height)
```
    Description copied from class: Component
    
    Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
    
    Overrides:
    
    onResize in class Component
    
    Parameters:
    
    width - the width
    
    height - the height

Class DrawComponent

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.Component

Constructor Summary

Method Summary

Methods inherited from class com.sencha.gxt.widget.core.client.Component

Methods inherited from class java.lang.Object

Field Detail

surface

Constructor Detail

DrawComponent

DrawComponent

Method Detail

addGradient

addSprite

addSpriteHandler

addSpriteOutHandler

addSpriteOverHandler

addSpriteSelectionHandler

addSpriteUpHandler

clearSurface

getBackground

getSurface

isViewBox

onBrowserEvent

onMouseDown

onMouseMove

onMouseOut

onMouseUp

redrawSurface

redrawSurfaceForced

remove

renderSprite

setBackground

setPixelSize

setViewBox

ensureHandler

getEventXY

onAttach

onResize