aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/main/java/com/vaadin/ui/TwinColSelect.java
blob: 37b79a6bac5c5ccdbf01c981acf2388a2b6951a4 (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
 * Copyright 2000-2016 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;

import java.util.Collection;

import com.vaadin.data.Listing;
import com.vaadin.server.data.DataProvider;
import com.vaadin.shared.ui.twincolselect.TwinColSelectState;

/**
 * Multiselect component with two lists: left side for available items and right
 * side for selected items.
 *
 * @author Vaadin Ltd
 *
 * @param <T>
 *            item type
 */
public class TwinColSelect<T> extends AbstractMultiSelect<T>
        implements Listing<T, DataProvider<T, ?>> {

    /**
     * Constructs a new TwinColSelect.
     */
    public TwinColSelect() {
    }

    /**
     * Constructs a new TwinColSelect with the given caption.
     *
     * @param caption
     *            the caption to set, can be {@code null}
     */
    public TwinColSelect(String caption) {
        this();
        setCaption(caption);
    }

    /**
     * Constructs a new TwinColSelect with caption and data provider for
     * options.
     *
     * @param caption
     *            the caption to set, can be {@code null}
     * @param dataProvider
     *            the data provider, not {@code null}
     */
    public TwinColSelect(String caption, DataProvider<T, ?> dataProvider) {
        this(caption);
        setDataProvider(dataProvider);
    }

    /**
     * Constructs a new TwinColSelect with caption and the given options.
     *
     * @param caption
     *            the caption to set, can be {@code null}
     * @param options
     *            the options, cannot be {@code null}
     */
    public TwinColSelect(String caption, Collection<T> options) {
        this(caption, DataProvider.create(options));
    }

    /**
     * Returns the number of rows in the selects.
     *
     * @return the number of rows visible
     */
    public int getRows() {
        return getState(false).rows;
    }

    /**
     * Sets the number of rows in the selects. If the number of rows is set to 0
     * or less, the actual number of displayed rows is determined implicitly by
     * the selects.
     * <p>
     * If a height if set (using {@link #setHeight(String)} or
     * {@link #setHeight(float, int)}) it overrides the number of rows. Leave
     * the height undefined to use this method.
     *
     * @param rows
     *            the number of rows to set.
     */
    public void setRows(int rows) {
        if (rows < 0) {
            rows = 0;
        }
        if (getState(false).rows != rows) {
            getState().rows = rows;
        }
    }

    /**
     * Sets the text shown above the right column. {@code null} clears the
     * caption.
     *
     * @param rightColumnCaption
     *            The text to show, {@code null} to clear
     */
    public void setRightColumnCaption(String rightColumnCaption) {
        getState().rightColumnCaption = rightColumnCaption;
    }

    /**
     * Returns the text shown above the right column.
     *
     * @return The text shown or {@code null} if not set.
     */
    public String getRightColumnCaption() {
        return getState(false).rightColumnCaption;
    }

    /**
     * Sets the text shown above the left column. {@code null} clears the
     * caption.
     *
     * @param leftColumnCaption
     *            The text to show, {@code null} to clear
     */
    public void setLeftColumnCaption(String leftColumnCaption) {
        getState().leftColumnCaption = leftColumnCaption;
        markAsDirty();
    }

    /**
     * Returns the text shown above the left column.
     *
     * @return The text shown or {@code null} if not set.
     */
    public String getLeftColumnCaption() {
        return getState(false).leftColumnCaption;
    }

    @Override
    protected TwinColSelectState getState() {
        return (TwinColSelectState) super.getState();
    }

    @Override
    protected TwinColSelectState getState(boolean markAsDirty) {
        return (TwinColSelectState) super.getState(markAsDirty);
    }

    @Override
    public DataProvider<T, ?> getDataProvider() {
        return internalGetDataProvider();
    }

    @Override
    public void setDataProvider(DataProvider<T, ?> dataProvider) {
        internalSetDataProvider(dataProvider);
    }

}