com.adobe.acs.commons.mcp.form.FormField Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation
Main ACS AEM Commons OSGi Bundle. Includes commons utilities.
There is a newer version: 6.9.4
Show newest version
/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 Adobe
 *
 * 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.adobe.acs.commons.mcp.form;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.osgi.annotation.versioning.ProviderType;

/**
 * Annotation used to declare process inputs.
 */
@ProviderType
@Target(value={ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface FormField {

    String name();

    String hint() default "";

    String description() default "";

    String category() default "";

    boolean required() default false;

    Class component() default TextfieldComponent.class;

    String[] options() default {};

    boolean showOnCreate() default true;

    boolean localize() default false;

    String[] languages() default { "en" };

    public static class Factory {
        private Factory() {
            // Factory cannot be instantiated
        }

        public static FormField create(String name, String hint, String description, String category, boolean required, Class clazz, String[] options) {
            return create(name, hint, description, category, required, clazz, options, false, new String[]{"en"});
        }

        // Create FormField annotation, used to programatically generate forms when introspection isn't an option.
        public static FormField create(String name, String hint, String description, String category, boolean required, Class clazz, String[] options, boolean localize, String[] languages) {
            return new FormField() {
                @Override
                public String name() {
                    return name;
                }

                @Override
                public String hint() {
                    return hint;
                }

                @Override
                public String description() {
                    return description;
                }

                @Override
                public String category() {
                    return category;
                }

                @Override
                public boolean required() {
                    return required;
                }

                @Override
                public Class component() {
                    return clazz;
                }

                @Override
                public String[] options() {
                    return options == null ? new String[0] : options;
                }

                @Override
                public Class annotationType() {
                    return null;
                }

                @Override
                public boolean showOnCreate() {
                    return true;
                }

                @Override
                public boolean localize() {
                    return localize;
                }

                @Override
                public String[] languages() {
                    return languages;
                }
            };
        }
    }
}