com.adobe.aemds.guide.common.StyledFDField Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2017 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/

package com.adobe.aemds.guide.common;


import com.day.cq.wcm.foundation.forms.FormsConstants;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.osgi.annotation.versioning.ConsumerType;

import javax.annotation.Nonnull;

/**
 * Defines the {@code Text} Sling Model for the Styled Adaptive Form & Documents component.
 */
@ConsumerType
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface StyledFDField extends FDField {

    /**
     * @return Returns the width of the component, if no width is configured it would return an empty string
     */
    @Nonnull
    @JsonProperty("width")
    String getWidth();

    /**
     * @return Returns the height of the component, if no height is configured it would return an empty string
     */
    @Nonnull
    @JsonProperty("height")
    String getHeight();

    /**
     * @return Returns the CSS Class name configured for the component, if no CSS Class name is configured it would return an empty string
     */
    @Nonnull
    @JsonProperty("cssClassName")
    String getCssClassName();

}