001/** 002 * Copyright (C) 2006-2018 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("Advanced layout to place properties by row, this is exclusive with `@OptionsOrder`.") 031@Target(TYPE) 032@Retention(RUNTIME) 033@Repeatable(GridLayouts.class) 034public @interface GridLayout { 035 036 interface FormType { 037 038 String MAIN = "Main"; 039 040 String ADVANCED = "Advanced"; 041 042 @Deprecated // this one means nothing, surely to drop and use main instead 043 String CITIZEN = "CitizenUser"; 044 } 045 046 /** 047 * @return the ordered list of rows of the layout. 048 */ 049 Row[] value(); 050 051 /** 052 * @return the form name associated to this definition. 053 */ 054 String[] names() default FormType.MAIN; 055 056 /** 057 * Defines a UI row (list of widgets). 058 */ 059 @Target(PARAMETER) 060 @Retention(RUNTIME) 061 @interface Row { 062 063 /** 064 * @return the ordered list of property/widgets to set on this row. 065 */ 066 String[] value(); 067 } 068}