1 /**
2 * This file Copyright (c) 2012-2018 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.I18nText;
37 import info.magnolia.i18nsystem.I18nable;
38 import info.magnolia.ui.workbench.definition.WorkbenchDefinition;
39
40 /**
41 * Defines a column in a workbench.
42 *
43 * @see WorkbenchDefinition
44 */
45 @I18nable(keyGenerator = ColumnDefinitionKeyGenerator.class)
46 public interface ColumnDefinition {
47
48 String getName();
49
50 String getPropertyName();
51
52 @I18nText
53 String getLabel();
54
55 /**
56 * Sets columns width (in pixels). See {@link #getExpandRatio()}.
57 */
58 int getWidth();
59
60 /**
61 * Expand ratios can be defined to customize the way how excess space is divided among columns.
62 * A table can have excess space if it has its width defined and there is horizontally more
63 * space than columns consume naturally. Excess space is the space that is not used by columns
64 * with explicit width (see {@link #getWidth()}) or with natural width (no width nor expand
65 * ratio).
66 */
67 float getExpandRatio();
68
69 boolean isSortable();
70
71 Class<? extends ColumnFormatter> getFormatterClass();
72
73 Class<?> getType();
74
75 boolean isDisplayInChooseDialog();
76
77 /**
78 * Returns whether this column and therefore the underlying JCR property it represents is to be
79 * included in searches. Its value is <code>true</code> by default.
80 */
81 boolean isSearchable();
82
83 /**
84 * Returns whether this column should be editable if workbench uses inplace editing.
85 *
86 * @return true, if column is editable
87 * @see WorkbenchDefinition#isEditable()
88 */
89 boolean isEditable();
90
91 /**
92 * If false - the column will not be displayed.
93 * useful for turning a column off when extending a columns configuration.
94 *
95 * @return
96 */
97 boolean isEnabled();
98
99 /**
100 * Returns the AvailabilityRule object for this subject.
101 */
102 Class<? extends ColumnAvailabilityRule> getRuleClass();
103 }