Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
GWT 2.1.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.google.gwt.user.cellview.client
Class AbstractHasData<T>

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.google.gwt.user.cellview.client.AbstractHasData<T>
Type Parameters:
T - the data type of each row
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, HasKeyboardPagingPolicy, HasKeyboardSelectionPolicy, EventListener, Focusable, IsWidget, HasData<T>, HasKeyProvider<T>, HasRows
Direct Known Subclasses:
CellList, CellTable
public abstract class AbstractHasData<T>
extends Widget
implements HasData<T>, HasKeyProvider<T>, Focusable, HasKeyboardPagingPolicy

An abstract Widget that implements HasData.

Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Nested classes/interfaces inherited from interface com.google.gwt.user.cellview.client.HasKeyboardPagingPolicy
HasKeyboardPagingPolicy.KeyboardPagingPolicy
 
Nested classes/interfaces inherited from interface com.google.gwt.user.cellview.client.HasKeyboardSelectionPolicy
HasKeyboardSelectionPolicy.KeyboardSelectionPolicy
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
AbstractHasData(Element elem, int pageSize, ProvidesKey<T> keyProvider)
          Constructs an AbstractHasData with the given page size.
 
Method Summary
 HandlerRegistration addRangeChangeHandler(RangeChangeEvent.Handler handler)
          Add a RangeChangeEvent.Handler.
 HandlerRegistration addRowCountChangeHandler(RowCountChangeEvent.Handler handler)
          Add a RowCountChangeEvent.Handler.
protected  boolean cellConsumesEventType(Cell<?> cell, java.lang.String eventType)
          Check if a cell consumes the specified event type.
protected  void checkRowBounds(int row)
          Check that the row is within the correct bounds.
protected  Element convertToElements(SafeHtml html)
          Convert the specified HTML into DOM elements and return the parent of the DOM elements.
protected abstract  boolean dependsOnSelection()
          Check whether or not the cells in the view depend on the selection state.
 char getAccessKey()
          Get the access key.
protected abstract  Element getChildContainer()
          Return the element that holds the rendered cells.
 T getDisplayedItem(int indexOnPage)
          Get the row value at the specified visible index.
 java.util.List<T> getDisplayedItems()
          Return the row values that the widget is currently displaying.
 HasKeyboardPagingPolicy.KeyboardPagingPolicy getKeyboardPagingPolicy()
          Get the HasKeyboardPagingPolicy.KeyboardPagingPolicy.
protected abstract  Element getKeyboardSelectedElement()
          Get the element that has keyboard selection.
protected  int getKeyboardSelectedRow()
          Get the row index of the keyboard selected row.
 HasKeyboardSelectionPolicy.KeyboardSelectionPolicy getKeyboardSelectionPolicy()
          Get the HasKeyboardSelectionPolicy.KeyboardSelectionPolicy.
 ProvidesKey<T> getKeyProvider()
          Return the key provider.
 int getPageSize()
          Return the range size.
 int getPageStart()
          Return the range start.
 int getRowCount()
          Get the total count of all rows.
 SelectionModel<? super T> getSelectionModel()
          Get the SelectionModel used by this HasData.
 int getTabIndex()
          Gets the widget's position in the tab index.
protected  java.lang.Object getValueKey(T value)
          Get the key for the specified value.
 Range getVisibleRange()
          Get the range of visible rows.
protected abstract  boolean isKeyboardNavigationSuppressed()
          Check if keyboard navigation is being suppressed, such as when the user is editing a cell.
 boolean isRowCountExact()
          Check if the total row count is exact, or an estimate.
protected  boolean isRowWithinBounds(int row)
          Checks that the row is within the correct bounds.
protected  void onBlur()
          Called when the widget is blurred.
 void onBrowserEvent(Event event)
          Handle browser events.
protected  void onBrowserEvent2(Event event)
          Called after onBrowserEvent(Event) completes.
protected  void onFocus()
          Called when the widget is focused.
protected  void onUnload()
          This method is called immediately before a widget will be detached from the browser's document.
protected  void onUpdateSelection()
          Called when selection changes.
 void redraw()
          Redraw the widget using the existing data.
protected abstract  void renderRowValues(SafeHtmlBuilder sb, java.util.List<T> values, int start, SelectionModel<? super T> selectionModel)
          Render all row values into the specified SafeHtmlBuilder.
protected  void replaceAllChildren(java.util.List<T> values, SafeHtml html)
          Replace all children with the specified html.
protected  void replaceChildren(java.util.List<T> values, int start, SafeHtml html)
          Convert the specified HTML into DOM elements and replace the existing elements starting at the specified index.
protected abstract  boolean resetFocusOnCell()
          Reset focus on the currently focused cell.
 void setAccessKey(char key)
          Sets the widget's 'access key'.
 void setFocus(boolean focused)
          Explicitly focus/unfocus this widget.
protected  void setFocusable(Element elem, boolean focusable)
          Make an element focusable or not.
 void setKeyboardPagingPolicy(HasKeyboardPagingPolicy.KeyboardPagingPolicy policy)
          Set the HasKeyboardPagingPolicy.KeyboardPagingPolicy.
protected abstract  void setKeyboardSelected(int index, boolean selected, boolean stealFocus)
          Update an element to reflect its keyboard selected state.
 void setKeyboardSelectionPolicy(HasKeyboardSelectionPolicy.KeyboardSelectionPolicy policy)
          Set the HasKeyboardSelectionPolicy.KeyboardSelectionPolicy.
 void setPageSize(int pageSize)
          Set the number of rows per page and refresh the view.
 void setPageStart(int pageStart)
          Set the starting index of the current visible page.
 void setRowCount(int count)
          Set the exact total count of all rows.
 void setRowCount(int size, boolean isExact)
          Set the total count of all rows, specifying whether the count is exact or an estimate.
 void setRowData(int start, java.util.List<? extends T> values)
          Set a values associated with the rows in the visible range.
protected abstract  void setSelected(Element elem, boolean selected)
          Update an element to reflect its selected state.
 void setSelectionModel(SelectionModel<? super T> selectionModel)
          Set the SelectionModel used by this HasData.
 void setTabIndex(int index)
          Sets the widget's position in the tab index.
 void setVisibleRange(int start, int length)
          Set the visible range or rows.
 void setVisibleRange(Range range)
          Set the visible range or rows.
 void setVisibleRangeAndClearData(Range range, boolean forceRangeChangeEvent)
           Set the visible range and clear the current visible data.
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

AbstractHasData

public AbstractHasData(Element elem,
                       int pageSize,
                       ProvidesKey<T> keyProvider)
Constructs an AbstractHasData with the given page size.

Parameters:
elem - the parent Element
pageSize - the page size
keyProvider - the key provider, or null
Method Detail

addRangeChangeHandler

public HandlerRegistration addRangeChangeHandler(RangeChangeEvent.Handler handler)
Description copied from interface: HasRows
Add a RangeChangeEvent.Handler.

Specified by:
addRangeChangeHandler in interface HasRows
Parameters:
handler - the handler
Returns:
a HandlerRegistration to remove the handler

addRowCountChangeHandler

public HandlerRegistration addRowCountChangeHandler(RowCountChangeEvent.Handler handler)
Description copied from interface: HasRows
Add a RowCountChangeEvent.Handler.

Specified by:
addRowCountChangeHandler in interface HasRows
Parameters:
handler - the handler
Returns:
a HandlerRegistration to remove the handler

getAccessKey

public char getAccessKey()
Get the access key.

Returns:
the access key, or -1 if not set
See Also:
setAccessKey(char)

getDisplayedItem

public T getDisplayedItem(int indexOnPage)
Get the row value at the specified visible index. Index 0 corresponds to the first item on the page.

Parameters:
indexOnPage - the index on the page
Returns:
the row value

getDisplayedItems

public java.util.List<T> getDisplayedItems()
Return the row values that the widget is currently displaying.

Returns:
a List of displayed items

getKeyboardPagingPolicy

public HasKeyboardPagingPolicy.KeyboardPagingPolicy getKeyboardPagingPolicy()
Description copied from interface: HasKeyboardPagingPolicy
Get the HasKeyboardPagingPolicy.KeyboardPagingPolicy.

Specified by:
getKeyboardPagingPolicy in interface HasKeyboardPagingPolicy
Returns:
the paging policy
See Also:
HasKeyboardPagingPolicy.setKeyboardPagingPolicy(KeyboardPagingPolicy)

getKeyboardSelectionPolicy

public HasKeyboardSelectionPolicy.KeyboardSelectionPolicy getKeyboardSelectionPolicy()
Description copied from interface: HasKeyboardSelectionPolicy
Get the HasKeyboardSelectionPolicy.KeyboardSelectionPolicy.

Specified by:
getKeyboardSelectionPolicy in interface HasKeyboardSelectionPolicy
Returns:
the selection policy
See Also:
HasKeyboardSelectionPolicy.setKeyboardSelectionPolicy(KeyboardSelectionPolicy)

getKeyProvider

public ProvidesKey<T> getKeyProvider()
Description copied from interface: HasKeyProvider
Return the key provider.

Specified by:
getKeyProvider in interface HasKeyProvider<T>
Returns:
the ProvidesKey instance

getPageSize

public final int getPageSize()
Return the range size.

Returns:
the size of the range as an int
See Also:
getVisibleRange(), setPageSize(int)

getPageStart

public final int getPageStart()
Return the range start.

Returns:
the start of the range as an int
See Also:
getVisibleRange(), setPageStart(int)

getRowCount

public int getRowCount()
Description copied from interface: HasRows
Get the total count of all rows.

Specified by:
getRowCount in interface HasRows
Returns:
the total row count
See Also:
HasRows.setRowCount(int)

getSelectionModel

public SelectionModel<? super T> getSelectionModel()
Description copied from interface: HasData
Get the SelectionModel used by this HasData.

Specified by:
getSelectionModel in interface HasData<T>
Returns:
the SelectionModel
See Also:
HasData.setSelectionModel(SelectionModel)

getTabIndex

public int getTabIndex()
Description copied from interface: Focusable
Gets the widget's position in the tab index.

Specified by:
getTabIndex in interface Focusable
Returns:
the widget's tab index

getVisibleRange

public Range getVisibleRange()
Description copied from interface: HasRows
Get the range of visible rows.

Specified by:
getVisibleRange in interface HasRows
Returns:
the visible range
See Also:
HasRows.setVisibleRange(Range), HasRows.setVisibleRange(int, int)

isRowCountExact

public boolean isRowCountExact()
Description copied from interface: HasRows
Check if the total row count is exact, or an estimate.

Specified by:
isRowCountExact in interface HasRows
Returns:
true if exact, false if an estimate

onBrowserEvent

public final void onBrowserEvent(Event event)
Handle browser events. Subclasses should override onBrowserEvent2(Event) if they want to extend browser event handling.

Specified by:
onBrowserEvent in interface EventListener
Overrides:
onBrowserEvent in class Widget
Parameters:
event - the event received
See Also:
onBrowserEvent2(Event)

redraw

public void redraw()
Redraw the widget using the existing data.

setAccessKey

public void setAccessKey(char key)
Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.

Specified by:
setAccessKey in interface Focusable
Parameters:
key - the widget's access key
See Also:
getAccessKey()

setFocus

public void setFocus(boolean focused)
Description copied from interface: Focusable
Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

Specified by:
setFocus in interface Focusable
Parameters:
focused - whether this widget should take focus or release it

setKeyboardPagingPolicy

public void setKeyboardPagingPolicy(HasKeyboardPagingPolicy.KeyboardPagingPolicy policy)
Description copied from interface: HasKeyboardPagingPolicy
Set the HasKeyboardPagingPolicy.KeyboardPagingPolicy.

Specified by:
setKeyboardPagingPolicy in interface HasKeyboardPagingPolicy
Parameters:
policy - the paging policy
See Also:
HasKeyboardPagingPolicy.getKeyboardPagingPolicy()

setKeyboardSelectionPolicy

public void setKeyboardSelectionPolicy(HasKeyboardSelectionPolicy.KeyboardSelectionPolicy policy)
Description copied from interface: HasKeyboardSelectionPolicy
Set the HasKeyboardSelectionPolicy.KeyboardSelectionPolicy.

Specified by:
setKeyboardSelectionPolicy in interface HasKeyboardSelectionPolicy
Parameters:
policy - the selection policy
See Also:
HasKeyboardSelectionPolicy.getKeyboardSelectionPolicy()

setPageSize

public final void setPageSize(int pageSize)
Set the number of rows per page and refresh the view.

Parameters:
pageSize - the page size
See Also:
setVisibleRange(Range), getPageSize()

setPageStart

public final void setPageStart(int pageStart)
Set the starting index of the current visible page. The actual page start will be clamped in the range [0, getSize() - 1].

Parameters:
pageStart - the index of the row that should appear at the start of the page
See Also:
setVisibleRange(Range), getPageStart()

setRowCount

public final void setRowCount(int count)
Description copied from interface: HasRows
Set the exact total count of all rows. This method defers to HasRows.setRowCount(int, boolean).

Specified by:
setRowCount in interface HasRows
Parameters:
count - the exact total count
See Also:
HasRows.getRowCount()

setRowCount

public void setRowCount(int size,
                        boolean isExact)
Description copied from interface: HasRows
Set the total count of all rows, specifying whether the count is exact or an estimate.

Specified by:
setRowCount in interface HasRows
Parameters:
size - the total count
isExact - true if the count is exact, false if an estimate
See Also:
HasRows.getRowCount()

setRowData

public void setRowData(int start,
                       java.util.List<? extends T> values)
Description copied from interface: HasData
Set a values associated with the rows in the visible range.

Specified by:
setRowData in interface HasData<T>
Parameters:
start - the start index of the data
values - the values within the range

setSelectionModel

public void setSelectionModel(SelectionModel<? super T> selectionModel)
Description copied from interface: HasData
Set the SelectionModel used by this HasData.

Specified by:
setSelectionModel in interface HasData<T>
Parameters:
selectionModel - the SelectionModel
See Also:
HasData.getSelectionModel()

setTabIndex

public void setTabIndex(int index)
Description copied from interface: Focusable
Sets the widget's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.

Specified by:
setTabIndex in interface Focusable
Parameters:
index - the widget's tab index

setVisibleRange

public final void setVisibleRange(int start,
                                  int length)
Description copied from interface: HasRows
Set the visible range or rows. This method defers to HasRows.setVisibleRange(Range).

Specified by:
setVisibleRange in interface HasRows
Parameters:
start - the start index
length - the length
See Also:
HasRows.getVisibleRange()

setVisibleRange

public void setVisibleRange(Range range)
Description copied from interface: HasRows
Set the visible range or rows.

Specified by:
setVisibleRange in interface HasRows
Parameters:
range - the visible range
See Also:
HasRows.getVisibleRange()

setVisibleRangeAndClearData

public void setVisibleRangeAndClearData(Range range,
                                        boolean forceRangeChangeEvent)
Description copied from interface: HasData

Set the visible range and clear the current visible data.

If the second argument forceRangeChangeEvent is true, a RangeChangeEvent will be fired even if the range does not change. If false, a RangeChangeEvent will only be fired if the range changes.

Specified by:
setVisibleRangeAndClearData in interface HasData<T>
Parameters:
range - the new Range
forceRangeChangeEvent - true to fire a RangeChangeEvent even if the Range doesn't change

cellConsumesEventType

protected boolean cellConsumesEventType(Cell<?> cell,
                                        java.lang.String eventType)
Check if a cell consumes the specified event type.

Parameters:
cell - the cell
eventType - the event type to check
Returns:
true if consumed, false if not

checkRowBounds

protected void checkRowBounds(int row)
Check that the row is within the correct bounds.

Parameters:
row - row index to check
Throws:
java.lang.IndexOutOfBoundsException

convertToElements

protected Element convertToElements(SafeHtml html)
Convert the specified HTML into DOM elements and return the parent of the DOM elements.

Parameters:
html - the HTML to convert
Returns:
the parent element

dependsOnSelection

protected abstract boolean dependsOnSelection()
Check whether or not the cells in the view depend on the selection state.

Returns:
true if cells depend on selection, false if not

getChildContainer

protected abstract Element getChildContainer()
Return the element that holds the rendered cells.

Returns:
the container Element

getKeyboardSelectedElement

protected abstract Element getKeyboardSelectedElement()
Get the element that has keyboard selection.

Returns:
the keyboard selected element

getKeyboardSelectedRow

protected int getKeyboardSelectedRow()
Get the row index of the keyboard selected row.

Returns:
the row index

getValueKey

protected java.lang.Object getValueKey(T value)
Get the key for the specified value.

Parameters:
value - the value
Returns:
the key

isKeyboardNavigationSuppressed

protected abstract boolean isKeyboardNavigationSuppressed()
Check if keyboard navigation is being suppressed, such as when the user is editing a cell.

Returns:
true if suppressed, false if not

isRowWithinBounds

protected boolean isRowWithinBounds(int row)
Checks that the row is within the correct bounds.

Parameters:
row - row index to check
Returns:
true if within bounds, false if not

onBlur

protected void onBlur()
Called when the widget is blurred.

onBrowserEvent2

protected void onBrowserEvent2(Event event)
Called after onBrowserEvent(Event) completes.

Parameters:
event - the event that was fired

onFocus

protected void onFocus()
Called when the widget is focused.

onUnload

protected void onUnload()
Description copied from class: Widget
This method is called immediately before a widget will be detached from the browser's document.

Overrides:
onUnload in class Widget

onUpdateSelection

protected void onUpdateSelection()
Called when selection changes.

renderRowValues

protected abstract void renderRowValues(SafeHtmlBuilder sb,
                                        java.util.List<T> values,
                                        int start,
                                        SelectionModel<? super T> selectionModel)
Render all row values into the specified SafeHtmlBuilder.

Parameters:
sb - the SafeHtmlBuilder to render into
values - the row values
start - the start index of the values
selectionModel - the SelectionModel

replaceAllChildren

protected void replaceAllChildren(java.util.List<T> values,
                                  SafeHtml html)
Replace all children with the specified html.

Parameters:
values - the values of the new children
html - the html to render in the child

replaceChildren

protected void replaceChildren(java.util.List<T> values,
                               int start,
                               SafeHtml html)
Convert the specified HTML into DOM elements and replace the existing elements starting at the specified index. If the number of children specified exceeds the existing number of children, the remaining children should be appended.

Parameters:
values - the values of the new children
start - the start index to be replaced
html - the HTML to convert

resetFocusOnCell

protected abstract boolean resetFocusOnCell()
Reset focus on the currently focused cell.

Returns:
true if focus is taken, false if not

setFocusable

protected void setFocusable(Element elem,
                            boolean focusable)
Make an element focusable or not.

Parameters:
elem - the element
focusable - true to make focusable, false to make unfocusable

setKeyboardSelected

protected abstract void setKeyboardSelected(int index,
                                            boolean selected,
                                            boolean stealFocus)
Update an element to reflect its keyboard selected state.

Parameters:
index - the index of the element
selected - true if selected, false if not
stealFocus - true if the row should steal focus, false if not

setSelected

protected abstract void setSelected(Element elem,
                                    boolean selected)
Update an element to reflect its selected state.

Parameters:
elem - the element to update
selected - true if selected, false if not
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
GWT 2.1.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD