001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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    package org.kuali.kfs.sys.document.web;
017    
018    /**
019     * A contract for accounting line view layout elements which join tables as part of an AccountingLineViewLines element
020     */
021    public interface AccountingLineViewLineFillingElement extends TableJoining, ReadOnlyable {
022        /**
023         * Finds the number of table cells this line expects to take up
024         * @return the number of displayed table cells this line expects to render as
025         */
026        public abstract int getDisplayingFieldWidth();
027        
028        /**
029         * A way to ask the line filling element if it wants its cell to be stretched to fill the line
030         * @return true if the line filling element should stretch its cell to fill the line; if false (or if the line contains more than a single cell), the line will be padded out with an empty cell
031         */
032        public abstract boolean shouldStretchToFillLine();
033    }