001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.metamodel.facets.object.membergroups;
021
022import java.util.List;
023
024import org.apache.isis.applib.annotation.MemberGroupLayout.ColumnSpans;
025import org.apache.isis.core.metamodel.facetapi.Facet;
026import org.apache.isis.core.metamodel.facets.members.order.MemberOrderFacet;
027
028/**
029 * Indicates the (column) layout of property groups (as defined by {@link MemberOrderFacet})
030 * and collections.
031 * 
032 * <p>
033 * Corresponds to the {@link MemberGroupsFacet} annotation in the applib.
034 */
035public interface MemberGroupLayoutFacet extends Facet {
036
037    /**
038     * The default group for properties if not otherwise specified.
039     */
040    public final static String DEFAULT_GROUP = "General";
041
042    public ColumnSpans getColumnSpans();
043
044    public List<String> getLeft();
045    public List<String> getMiddle();
046    public List<String> getRight();
047}