001package org.gwtbootstrap3.client.ui;
002
003/*
004 * #%L
005 * GwtBootstrap3
006 * %%
007 * Copyright (C) 2013 GwtBootstrap3
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import org.gwtbootstrap3.client.ui.base.HasSize;
024import org.gwtbootstrap3.client.ui.base.helper.StyleHelper;
025import org.gwtbootstrap3.client.ui.constants.Styles;
026import org.gwtbootstrap3.client.ui.constants.WellSize;
027import org.gwtbootstrap3.client.ui.html.Div;
028
029/**
030 * Widget representing the Bootstrap Well
031 * <p/>
032 * <a href="http://getbootstrap.com/components/#wells">Bootstrap Documentation</a>
033 * <p/>
034 * <h3>UiBinder example</h3>
035 * <p/>
036 * <pre>
037 * {@code
038 * <b:Well>
039 *    ...
040 * </b:Well>
041 * }
042 * </pre>
043 *
044 * @author Sven Jacobs
045 * @author Joshua Godi
046 */
047public class Well extends Div implements HasSize<WellSize> {
048
049    /**
050     * Creates a Well with the default Bootstrap styling
051     */
052    public Well() {
053        setStyleName(Styles.WELL);
054    }
055
056    /**
057     * {@inheritDoc}
058     */
059    @Override
060    public void setSize(final WellSize size) {
061        StyleHelper.addUniqueEnumStyleName(this, WellSize.class, size);
062    }
063
064    /**
065     * {@inheritDoc}
066     */
067    @Override
068    public WellSize getSize() {
069        return WellSize.fromStyleName(getStyleName());
070    }
071}