1 /** 2 * This file Copyright (c) 2012-2015 Magnolia International 3 * Ltd. (http://www.magnolia-cms.com). All rights reserved. 4 * 5 * 6 * This file is dual-licensed under both the Magnolia 7 * Network Agreement and the GNU General Public License. 8 * You may elect to use one or the other of these licenses. 9 * 10 * This file is distributed in the hope that it will be 11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the 12 * implied warranty of MERCHANTABILITY or FITNESS FOR A 13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT. 14 * Redistribution, except as permitted by whichever of the GPL 15 * or MNA you select, is prohibited. 16 * 17 * 1. For the GPL license (GPL), you can redistribute and/or 18 * modify this file under the terms of the GNU General 19 * Public License, Version 3, as published by the Free Software 20 * Foundation. You should have received a copy of the GNU 21 * General Public License, Version 3 along with this program; 22 * if not, write to the Free Software Foundation, Inc., 51 23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 24 * 25 * 2. For the Magnolia Network Agreement (MNA), this file 26 * and the accompanying materials are made available under the 27 * terms of the MNA which accompanies this distribution, and 28 * is available at http://www.magnolia-cms.com/mna.html 29 * 30 * Any modifications to this file must keep this entire header 31 * intact. 32 * 33 */ 34 package info.magnolia.ui.workbench.column.definition; 35 36 import info.magnolia.i18nsystem.I18nable; 37 import info.magnolia.i18nsystem.I18nText; 38 39 /** 40 * Defines a column in a workbench. 41 * 42 * @see info.magnolia.ui.workbench.definition.WorkbenchDefinition 43 */ 44 @I18nable(keyGenerator = ColumnDefinitionKeyGenerator.class) 45 public interface ColumnDefinition { 46 47 String getName(); 48 49 String getPropertyName(); 50 51 @I18nText 52 String getLabel(); 53 54 /** 55 * Sets columns width (in pixels). See {@link #getExpandRatio()}. 56 */ 57 int getWidth(); 58 59 /** 60 * Expand ratios can be defined to customize the way how excess space is divided among columns. 61 * A table can have excess space if it has its width defined and there is horizontally more 62 * space than columns consume naturally. Excess space is the space that is not used by columns 63 * with explicit width (see {@link #getWidth()}) or with natural width (no width nor expand 64 * ratio). 65 */ 66 float getExpandRatio(); 67 68 boolean isSortable(); 69 70 Class<? extends ColumnFormatter> getFormatterClass(); 71 72 Class<?> getType(); 73 74 boolean isDisplayInChooseDialog(); 75 76 /** 77 * Returns whether this column and therefore the underlying JCR property it represents is to be 78 * included in searches. Its value is <code>true</code> by default. 79 */ 80 boolean isSearchable(); 81 82 /** 83 * Returns whether this column should be editable if workbench uses inplace editing. 84 * 85 * @return true, if column is editable 86 * @see info.magnolia.ui.workbench.definition.WorkbenchDefinition#isEditable() 87 */ 88 boolean isEditable(); 89 90 /** 91 * If false - the column will not be displayed. 92 * useful for turning a column off when extending a columns configuration. 93 * 94 * @return 95 */ 96 boolean isEnabled(); 97 98 /** 99 * Returns the AvailabilityRule object for this subject. 100 */ 101 Class<? extends ColumnAvailabilityRule> getRuleClass(); 102 }