com.vaadin.client.renderers

Class ButtonRenderer

java.lang.Object

com.vaadin.client.renderers.ComplexRenderer<T>

com.vaadin.client.renderers.WidgetRenderer<T,W>

com.vaadin.client.renderers.ClickableRenderer<String,com.google.gwt.user.client.ui.Button>

com.vaadin.client.renderers.ButtonRenderer

All Implemented Interfaces:

com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.shared.EventHandler, Renderer<String>

public class ButtonRenderer
extends ClickableRenderer<String,com.google.gwt.user.client.ui.Button>

A Renderer that displays buttons with textual captions. The values of the corresponding column are used as the captions. Click handlers can be added to the renderer, invoked when any of the rendered buttons is clicked.

Since:

7.4

Author:

Vaadin Ltd

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.client.renderers.ClickableRenderer

ClickableRenderer.RendererClickEvent<R>, ClickableRenderer.RendererClickHandler<R>

Constructor Summary

Constructors

Constructor and Description
ButtonRenderer()

Method Summary

Modifier and Type	Method and Description
com.google.gwt.user.client.ui.Button	createWidget() Creates a widget to attach to a cell.
boolean	isHtmlContentAllowed() Returns whether HTML content is allowed.
void	render(RendererCellReference cell, String text, com.google.gwt.user.client.ui.Button button) Renders a cell with a widget.
void	setHtmlContentAllowed(boolean htmlContentAllowed) Sets whether HTML content is allowed.

Methods inherited from class com.vaadin.client.renderers.ClickableRenderer

addClickHandler, onClick

Methods inherited from class com.vaadin.client.renderers.WidgetRenderer

getWidget, getWidget, init, render

Methods inherited from class com.vaadin.client.renderers.ComplexRenderer

destroy, destroy, getConsumedEvents, onActivate, onBrowserEvent, setContentVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

ButtonRenderer

public ButtonRenderer()

Method Detail

createWidget

public com.google.gwt.user.client.ui.Button createWidget()

Description copied from class: ClickableRenderer

Creates a widget to attach to a cell. The widgets will be attached to the cell after the cell element has been attached to DOM.

Implementation note: It is the implementing method's responsibility to add this as a click handler of the returned widget, or a widget nested therein, in order to make click events propagate properly to handlers registered via addClickHandler.

Specified by:

createWidget in class ClickableRenderer<String,com.google.gwt.user.client.ui.Button>

Returns:

widget to attach to a cell. All returned instances should be new widget instances without a parent.

setHtmlContentAllowed

public void setHtmlContentAllowed(boolean htmlContentAllowed)

Sets whether HTML content is allowed.

Parameters:

htmlContentAllowed - true if HTML content allowed, false if contents should be rendered as plain text

isHtmlContentAllowed

public boolean isHtmlContentAllowed()

Returns whether HTML content is allowed.

Returns:

true if HTML content allowed, false if contents are rendered as plain text

render

public void render(RendererCellReference cell,
                   String text,
                   com.google.gwt.user.client.ui.Button button)

Description copied from class: WidgetRenderer

Renders a cell with a widget. This provides a way to update any information in the widget that is cell specific. Do not detach the Widget here, it will be done automatically by the Grid when the widget is no longer needed.

For optimal performance, work done in this method should be kept to a minimum since it will be called continuously while the user is scrolling. The renderer can use Widget.setLayoutData(Object) to store cell data that might be needed in e.g. event listeners.

Specified by:

render in class WidgetRenderer<String,com.google.gwt.user.client.ui.Button>

Parameters:

cell - The cell to render. Note that the cell is a flyweight and should not be stored and used outside of this method as its contents will change.

text - the data of the cell

button - the widget embedded in the cell