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.multiline;
021
022import org.apache.isis.core.metamodel.facets.MultipleValueFacet;
023
024/**
025 * Whether the (string) property or parameter should be rendered over multiple
026 * lines.
027 * 
028 * <p>
029 * In the standard Apache Isis Programming Model, corresponds to the
030 * <tt>@MultiLine</tt> annotation.
031 */
032public interface MultiLineFacet extends MultipleValueFacet {
033
034    /**
035     * How many lines to use.
036     */
037    public int numberOfLines();
038
039    /**
040     * Whether carriage returns should be used to split over multiple lines or
041     * not.
042     * 
043     * <p>
044     * If set to <tt>true</tt>, then user must use carriage returns to split. If
045     * set to <tt>false</tt>, then the viewer should automatically wrap when
046     * spills over the length of one line.
047     */
048    public boolean preventWrapping();
049
050}