blob: fc1584a15c9064aa4a168c6b01282d8f0b0f95f6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* Copyright 2000-2022 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the 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<T> extends ClickableRenderer<T, String> {
/**
* 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<T> 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<T> 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).
* <p>
* By default everything is rendered as text.
*
* @param htmlContentAllowed
* <code>true</code> to render as HTML, <code>false</code> 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).
* <p>
* By default everything is rendered as text.
*
* @return <code>true</code> if the renderer renders a HTML,
* <code>false</code> if the content is rendered as text
*
* @since 8.0.3
*/
public boolean isHtmlContentAllowed() {
return getState(false).htmlContentAllowed;
}
}
|
