001/**
002 * Copyright (C) 2006-2026 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.api.configuration.ui.layout;
017
018import static java.lang.annotation.ElementType.PARAMETER;
019import static java.lang.annotation.ElementType.TYPE;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021
022import java.lang.annotation.Repeatable;
023import java.lang.annotation.Retention;
024import java.lang.annotation.Target;
025
026import org.talend.sdk.component.api.configuration.ui.meta.Ui;
027import org.talend.sdk.component.api.meta.Documentation;
028
029@Ui
030@Documentation("""
031               Advanced layout to place properties by row, this is exclusive with `@OptionsOrder`.
032
033               NOTE: the logic to handle forms (gridlayout names) is to use the only layout if there is only one defined, \
034               else to check if there are `Main` and `Advanced` and if at least `Main` exists, use them, else \
035               use all available layouts.""")
036@Target(TYPE)
037@Retention(RUNTIME)
038@Repeatable(GridLayouts.class)
039public @interface GridLayout {
040
041    interface FormType {
042
043        String MAIN = "Main";
044
045        String ADVANCED = "Advanced";
046
047        String CHECKPOINT = "Checkpoint";
048
049        @Deprecated // this one means nothing, surely to drop and use main instead
050        String CITIZEN = "CitizenUser";
051    }
052
053    /**
054     * @return the ordered list of rows of the layout.
055     */
056    Row[] value();
057
058    /**
059     * @return the form name associated to this definition.
060     */
061    String[] names() default FormType.MAIN;
062
063    /**
064     * Defines a UI row (list of widgets).
065     */
066    @Target(PARAMETER)
067    @Retention(RUNTIME)
068    @interface Row {
069
070        /**
071         * @return the ordered list of property/widgets to set on this row.
072         */
073        String[] value();
074    }
075}