com.smartgwt.client.widgets.grid.events

Class SelectionEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<H>

com.smartgwt.client.event.AbstractSmartEvent<H>

com.smartgwt.client.widgets.events.BrowserEvent<SelectionChangedHandler>

com.smartgwt.client.widgets.grid.events.SelectionEvent

public class SelectionEvent
extends BrowserEvent<SelectionChangedHandler>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

com.google.gwt.event.shared.GwtEvent.Type<H>

Field Summary

Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent

jsObj

Constructor Summary

Constructors

Constructor and Description
SelectionEvent(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(SelectionChangedHandler handler)
static <S extends HasSelectionChangedHandlers & com.google.gwt.event.shared.HasHandlers> void	fire(S source, com.google.gwt.core.client.JavaScriptObject jsObj) Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.
com.google.gwt.event.shared.GwtEvent.Type<SelectionChangedHandler>	getAssociatedType()
Canvas	getFiringCanvas() Returns the Canvas firing the event.
ListGridRecord	getRecord() record for which selection changed
ListGridRecord	getSelectedRecord() Return the first selected record in this component. This method is appropriate if selectionType is "single", or if you only care about the first selected record in a multiple-record selection.
ListGridRecord[]	getSelection() The selection associated with the listGrid.
boolean	getState() New selection state (true for selected, false for unselected)
static com.google.gwt.event.shared.GwtEvent.Type<SelectionChangedHandler>	getType() Gets the type associated with this event.

Methods inherited from class com.smartgwt.client.widgets.events.BrowserEvent

getX, getY, isAltKeyDown, isCtrlKeyDown, isLeftButtonDown, isRightButtonDown

Methods inherited from class com.smartgwt.client.event.AbstractSmartEvent

getFiringInstanceAsJavaScriptObject

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionEvent

public SelectionEvent(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getFiringCanvas

public Canvas getFiringCanvas()

Returns the Canvas firing the event.

Returns:

Canvas firing the event

fire

public static <S extends HasSelectionChangedHandlers & com.google.gwt.event.shared.HasHandlers> void fire(S source,
                                                                                                          com.google.gwt.core.client.JavaScriptObject jsObj)

Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.

Type Parameters:

S - The event source

Parameters:

source - the source of the handlers

jsObj - the native event

getType

public static com.google.gwt.event.shared.GwtEvent.Type<SelectionChangedHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

dispatch

protected void dispatch(SelectionChangedHandler handler)

Specified by:

dispatch in class com.google.gwt.event.shared.GwtEvent<SelectionChangedHandler>

getAssociatedType

public final com.google.gwt.event.shared.GwtEvent.Type<SelectionChangedHandler> getAssociatedType()

Overrides:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<SelectionChangedHandler>

getRecord

public ListGridRecord getRecord()

record for which selection changed

Returns:

record for which selection changed

getState

public boolean getState()

New selection state (true for selected, false for unselected)

Returns:

New selection state (true for selected, false for unselected)

getSelection

public ListGridRecord[] getSelection()

The selection associated with the listGrid. Alias for getRecord()

Returns:

the selection

getSelectedRecord

public ListGridRecord getSelectedRecord()

Return the first selected record in this component.

This method is appropriate if selectionType is "single", or if you only care about the first selected record in a multiple-record selection. To access all selected records, use ListGrid.getSelection instead.

Returns:

first selected record, or null if nothing selected