gwt.material.design.client.ui.MaterialCard Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * GwtMaterial
 * %%
 * Copyright (C) 2015 - 2017 GwtMaterialDesign
 * %%
 * 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.
 * #L%
 */
package gwt.material.design.client.ui;

import com.google.gwt.dom.client.Document;
import gwt.material.design.client.base.HasAxis;
import gwt.material.design.client.base.MaterialWidget;
import gwt.material.design.client.base.mixin.CssNameMixin;
import gwt.material.design.client.constants.Axis;
import gwt.material.design.client.constants.CssName;
import gwt.material.design.client.constants.Orientation;

//@formatter:off

/**
 * Cards are a convenient means of displaying content composed of different types
 * of objects. They’re also well-suited for presenting similar objects whose size
 * or supported actions can vary considerably, like photos with captions of variable
 * length.
 * UiBinder Usage:
 *  * {@code 
 * 
 *   
 *     
 *     
 *   
 *   
 *     
 *     
 *   
 * 
 *
 * 
 * 
 *   
 *     
 *     
 *   
 *
 *   
 *     
 *   
 *
 *   
 *     
 *     
 *   
 * 
 *
 * 
 * 
 *   
 *     
 *   
 *
 *   
 *     
 *   
 *
 *   
 *     
 *     
 *   
 *
 *   
 *     
 *     
 *   
 * }
 * 
 *
 * @author kevzlou7979
 * @author Ben Dol
 * @see Material Cards
 * @see Material Design Specification
 */
//@formatter:on
public class MaterialCard extends MaterialWidget implements HasAxis {

    private CssNameMixin axisMixin;

    /**
     * Creates an empty card.
     */
    public MaterialCard() {
        super(Document.get().createDivElement(), CssName.CARD);
    }

    @Override
    public void setGrid(String grid) {
        super.setGrid(grid);
        addStyleName(CssName.NO_PADDING);
    }

    /**
     * Replace by {@link MaterialWidget#setOrientation(Orientation)}
     * @param axis
     */
    @Deprecated
    @Override
    public void setAxis(Axis axis) {
        getAxisMixin().setCssName(axis);
    }

    /**
     * Replace by {@link MaterialWidget#getOrientation()}
     */
    @Deprecated
    @Override
    public Axis getAxis() {
        return getAxisMixin().getCssName();
    }

    protected CssNameMixin getAxisMixin() {
        if (axisMixin == null) {
            axisMixin = new CssNameMixin<>(this);
        }
        return axisMixin;
    }
}