001/*
002 *  Copyright 2018 Anyware Services
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.ametys.runtime.model;
017
018/**
019 * interface for group of view items
020 */
021public interface ViewItemGroup extends ViewItem, ViewItemContainer
022{
023    /** Role for tab view items */
024    public static final String TAB_ROLE = "tab";
025    
026    /** Role for fieldset view items */
027    public static final String FIELDSET_ROLE = "fieldset";
028    
029    /**
030     * Retrieves the role.
031     * @return the role.
032     */
033    public String getRole();
034    
035    /**
036     * Set the role.
037     * @param role the role.
038     */
039    public void setRole(String role);
040    
041    @Override
042    public default void copyTo(ViewItem item, ViewItemAccessor referenceViewItemAccessor, String itemPath)
043    {
044        ViewItem.super.copyTo(item, referenceViewItemAccessor, itemPath);
045        
046        assert item instanceof ViewItemGroup;
047        ViewHelper.addViewAccessorItems((ViewItemGroup) item, this, referenceViewItemAccessor, itemPath);
048    }
049}