org.fujion.component.Caption Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fujion-core Show documentation
There is a newer version: 3.1.0
/*
 * #%L
 * fujion
 * %%
 * Copyright (C) 2018 Fujion Framework
 * %%
 * 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 org.fujion.component;

import org.fujion.annotation.Component;
import org.fujion.annotation.Component.ChildTag;
import org.fujion.annotation.Component.PropertyGetter;
import org.fujion.annotation.Component.PropertySetter;

/**
 * Associates a label with another component.
 */
@Component(tag = "caption", widgetClass = "Caption", parentTag = "*", childTag = @ChildTag("*"), description = "Associates a label with another component.")
public class Caption extends BaseLabeledComponent {

    /**
     * Alignment of label relative to child component(s).
     */
    public enum LabelAlignment {
        START, CENTER, END
    }

    private LabelAlignment alignment = LabelAlignment.START;

    private String labelStyle;

    private String labelClass = "label-default";

    public Caption() {
        this(null);
    }

    public Caption(String label) {
        super(label);
        setPosition(LabelPositionAll.LEFT);
    }
    
    /**
     * Returns the position of the label relative to its associated component. Defaults to 'left'.
     *
     * @return May be one of: left, right, top, or bottom.
     */
    @Override
    @PropertyGetter(value = "position", description = "The position of the label relative to its associated component.")
    public LabelPositionAll getPosition() {
        return super.getPosition();
    }

    /**
     * Sets the position of the label relative to its associated component.
     *
     * @param position May be one of: left, right, top, or bottom.
     */
    @Override
    @PropertySetter(value = "position", defaultValue = "left", description = "The position of the label relative to its associated component.")
    public void setPosition(LabelPositionAll position) {
        super.setPosition(position);
    }

    /**
     * Returns the alignment of the label. Defaults to 'start'.
     *
     * @return May be one of start, center, end.
     */
    @PropertyGetter(value = "alignment", description = "The alignment of the label.")
    public LabelAlignment getAlignment() {
        return alignment;
    }

    /**
     * Sets the alignment of the label.
     *
     * @param alignment May be one of: start, center, end.
     */
    @PropertySetter(value = "alignment", defaultValue = "start", description = "The alignment of the label.")
    public void setAlignment(LabelAlignment alignment) {
        propertyChange("alignment", this.alignment, this.alignment = defaultify(alignment, LabelAlignment.START), true);
    }

    /**
     * Returns the style(s) associated with the label.
     *
     * @return The label style(s).
     */
    @PropertyGetter(value = "labelStyle", description = "The CSS style(s) associated with the label.")
    public String getLabelStyle() {
        return labelStyle;
    }

    /**
     * Sets the style(s) of the label.
     *
     * @param labelStyle The label style(s).
     */
    @PropertySetter(value = "labelStyle", description = "The CSS style(s) associated with the label.")
    public void setLabelStyle(String labelStyle) {
        propertyChange("labelStyle", this.labelStyle, this.labelStyle = trimify(labelStyle), true);
    }

    /**
     * Returns the CSS class(es) associated with the label.
     *
     * @return The label CSS class(es).
     */
    @PropertyGetter(value = "labelClass", description = "The CSS class(es) associated with the label.")
    public String getLabelClass() {
        return labelClass;
    }

    /**
     * Sets the CSS class(es) of the label.
     *
     * @param labelClass The label CSS class(es).
     */
    @PropertySetter(value = "labelClass", defaultValue = "label-default", description = "The CSS class(es) associated with the label.")
    public void setLabelClass(String labelClass) {
        propertyChange("labelClass", this.labelClass, this.labelClass = trimify(labelClass), true);
    }

}