public class

IconCellDecorator

extends Object
implements Cell<C>
java.lang.Object
   ↳ com.google.gwt.cell.client.IconCellDecorator<C>

Class Overview

A Cell decorator that adds an icon to another Cell.

Summary

Public Constructors
IconCellDecorator(ImageResource icon, Cell<C> cell)
Construct a new IconCellDecorator.
IconCellDecorator(ImageResource icon, Cell<C> cell, HasVerticalAlignment.VerticalAlignmentConstant valign, int spacing)
Construct a new IconCellDecorator.
Public Methods
boolean dependsOnSelection()
Check if this cell depends on the selection state.
Set<String> getConsumedEvents()
Get the set of events that this cell consumes.
boolean handlesSelection()
Check if this cell handles selection.
boolean isEditing(Cell.Context context, Element parent, C value)
Returns true if the cell is currently editing the data identified by the given element and key.
void onBrowserEvent(Cell.Context context, Element parent, C value, NativeEvent event, ValueUpdater<C> valueUpdater)
Handle a browser event that took place within the cell.
void render(Cell.Context context, C value, SafeHtmlBuilder sb)
Render a cell as HTML into a SafeHtmlBuilder, suitable for passing to setInnerHTML(String) on a container element.
boolean resetFocus(Cell.Context context, Element parent, C value)
Reset focus on the Cell.
void setValue(Cell.Context context, Element parent, C value)
This method may be used by cell containers to set the value on a single cell directly, rather than using setInnerHTML(String).
Protected Methods
SafeHtml getIconHtml(C value)
Get the safe HTML string that represents the icon.
boolean isIconUsed(C value)
Check if the icon should be used for the value.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.google.gwt.cell.client.Cell

Public Constructors

public IconCellDecorator (ImageResource icon, Cell<C> cell)

Construct a new IconCellDecorator. The icon and the content will be middle aligned by default.

Parameters
icon the icon to use
cell the cell to decorate

public IconCellDecorator (ImageResource icon, Cell<C> cell, HasVerticalAlignment.VerticalAlignmentConstant valign, int spacing)

Construct a new IconCellDecorator.

Parameters
icon the icon to use
cell the cell to decorate
valign the vertical alignment attribute of the contents
spacing the pixel space between the icon and the cell

Public Methods

public boolean dependsOnSelection ()

Check if this cell depends on the selection state.

Returns
  • true if dependent on selection, false if not

public Set<String> getConsumedEvents ()

Get the set of events that this cell consumes. The container that uses this cell should only pass these events to when the event occurs.

The returned value should not be modified, and may be an unmodifiable set. Changes to the return value may not be reflected in the cell.

Returns
  • the consumed events, or null if no events are consumed

public boolean handlesSelection ()

Check if this cell handles selection. If the cell handles selection, then its container should not automatically handle selection.

Returns
  • true if the cell handles selection, false if not

public boolean isEditing (Cell.Context context, Element parent, C value)

Returns true if the cell is currently editing the data identified by the given element and key. While a cell is editing, widgets containing the cell may choose to pass keystrokes directly to the cell rather than using them for navigation purposes.

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell
Returns
  • true if the cell is in edit mode

public void onBrowserEvent (Cell.Context context, Element parent, C value, NativeEvent event, ValueUpdater<C> valueUpdater)

Handle a browser event that took place within the cell. The default implementation returns null.

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell
event the native browser event
valueUpdater a ValueUpdater, or null if not specified

public void render (Cell.Context context, C value, SafeHtmlBuilder sb)

Render a cell as HTML into a SafeHtmlBuilder, suitable for passing to setInnerHTML(String) on a container element.

Note: If your cell contains natively focusable elements, such as buttons or input elements, be sure to set the tabIndex to -1 so that they do not steal focus away from the containing widget.

Parameters
context the Context of the cell
value the cell value to be rendered
sb the SafeHtmlBuilder to be written to

public boolean resetFocus (Cell.Context context, Element parent, C value)

Reset focus on the Cell. This method is called if the cell has focus when it is refreshed.

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell
Returns
  • true if focus is taken, false if not

public void setValue (Cell.Context context, Element parent, C value)

This method may be used by cell containers to set the value on a single cell directly, rather than using setInnerHTML(String). See AbstractCell#setValue(Context) for a default implementation that uses .

Parameters
context the Context of the cell
parent the parent Element
value the value associated with the cell

Protected Methods

protected SafeHtml getIconHtml (C value)

Get the safe HTML string that represents the icon. Override this method to change the icon based on the value.

Parameters
value the value being rendered
Returns
  • the HTML string that represents the icon

protected boolean isIconUsed (C value)

Check if the icon should be used for the value. If the icon should not be used, a placeholder of the same size will be used instead. The default implementations returns true.

Parameters
value the value being rendered
Returns
  • true to use the icon, false to use a placeholder