com.vaadin.ui.renderers.ButtonRenderer Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui.renderers;
import com.vaadin.shared.ui.grid.renderers.ButtonRendererState;
/**
* A Renderer that displays a button with a textual caption. The value of the
* corresponding property is used as the caption. Click listeners can be added
* to the renderer, invoked when any of the rendered buttons is clicked.
*
* @since 7.4
* @author Vaadin Ltd
*/
public class ButtonRenderer extends ClickableRenderer {
/**
* Creates a new button renderer.
*
* @param nullRepresentation
* the textual representation of {@code null} value
*/
public ButtonRenderer(String nullRepresentation) {
super(String.class, nullRepresentation);
}
/**
* Creates a new button renderer and adds the given click listener to it.
*
* @param listener
* the click listener to register
* @param nullRepresentation
* the textual representation of {@code null} value
*/
public ButtonRenderer(RendererClickListener listener,
String nullRepresentation) {
this(nullRepresentation);
addClickListener(listener);
}
/**
* Creates a new button renderer.
*/
public ButtonRenderer() {
this("");
}
/**
* Creates a new button renderer and adds the given click listener to it.
*
* @param listener
* the click listener to register
*/
public ButtonRenderer(RendererClickListener listener) {
this(listener, "");
}
@Override
public String getNullRepresentation() {
return super.getNullRepresentation();
}
@Override
protected ButtonRendererState getState() {
return (ButtonRendererState) super.getState();
}
@Override
protected ButtonRendererState getState(boolean markAsDirty) {
return (ButtonRendererState) super.getState(markAsDirty);
}
/**
* Sets whether the data should be rendered as HTML (instead of text).
*
* By default everything is rendered as text.
*
* @param htmlContentAllowed
* true to render as HTML, false to
* render as text
*
* @since 8.0.3
*/
public void setHtmlContentAllowed(boolean htmlContentAllowed) {
getState().htmlContentAllowed = htmlContentAllowed;
}
/**
* Gets whether the data should be rendered as HTML (instead of text).
*
* By default everything is rendered as text.
*
* @return true if the renderer renders a HTML,
* false if the content is rendered as text
*
* @since 8.0.3
*/
public boolean isHtmlContentAllowed() {
return getState(false).htmlContentAllowed;
}
}