001/*
002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Anahide Tchertchian
016 */
017package org.nuxeo.ecm.platform.forms.layout.api;
018
019import java.io.Serializable;
020
021/**
022 * Reference for a widget within a layout row.
023 *
024 * @since 5.5
025 */
026public interface WidgetReference extends Serializable {
027
028    /**
029     * Optional category on the widget: if this category is filled, the widget instance will be looked up with this
030     * category in the store
031     */
032    String getCategory();
033
034    /**
035     * Widget name. If a widget with this name is present in the layout definition, it references this widget. Else, if
036     * a category is filled, the widget is looked up in the store with this category. If no category is filled, the
037     * widget is looked up in the same store than the one of the layout.
038     */
039    String getName();
040
041    /**
042     * @since 5.5
043     */
044    WidgetReference clone();
045
046}