001/* 002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and others. 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 * 016 * Contributors: 017 * Anahide Tchertchian 018 */ 019package org.nuxeo.ecm.platform.forms.layout.api; 020 021import java.io.Serializable; 022 023/** 024 * Reference for a widget within a layout row. 025 * 026 * @since 5.5 027 */ 028public interface WidgetReference extends Serializable { 029 030 /** 031 * Optional category on the widget: if this category is filled, the widget instance will be looked up with this 032 * category in the store 033 */ 034 String getCategory(); 035 036 /** 037 * Widget name. If a widget with this name is present in the layout definition, it references this widget. Else, if 038 * a category is filled, the widget is looked up in the store with this category. If no category is filled, the 039 * widget is looked up in the same store than the one of the layout. 040 */ 041 String getName(); 042 043 /** 044 * @since 5.5 045 */ 046 WidgetReference clone(); 047 048}