|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object info.magnolia.ui.workbench.column.definition.AbstractColumnDefinition
public abstract class AbstractColumnDefinition
Base implementation for all special ColumnDefinitions. Some subclass do not add additional behavior but still are required because in jcr we configure ColumnDefinition to Column mappings and only with specific Definitions we know what Column-Type to map to.
Constructor Summary | |
---|---|
AbstractColumnDefinition()
|
Method Summary | |
---|---|
float |
getExpandRatio()
Expand ratios can be defined to customize the way how excess space is divided among columns. |
Class<? extends ColumnFormatter> |
getFormatterClass()
|
String |
getLabel()
|
String |
getName()
|
String |
getPropertyName()
|
Class<? extends ColumnAvailabilityRule> |
getRuleClass()
Returns the AvailabilityRule object for this subject. |
Class<?> |
getType()
The concrete type represented in this column, ie Long, Double, Date, etc. |
int |
getWidth()
Sets columns width (in pixels). |
boolean |
isDisplayInChooseDialog()
By default returns true . |
boolean |
isEditable()
Returns whether this column should be editable if workbench uses inplace editing. |
boolean |
isEnabled()
If false - the column will not be displayed. |
boolean |
isSearchable()
Returns whether this column and therefore the underlying JCR property it represents is to be included in searches. |
boolean |
isSortable()
|
void |
setDisplayInChooseDialog(boolean displayInChooseDialog)
|
void |
setEditable(boolean editable)
|
void |
setEnabled(boolean enabled)
|
void |
setExpandRatio(float expandRatio)
|
void |
setFormatterClass(Class<? extends ColumnFormatter> formatterClass)
|
void |
setLabel(String label)
|
void |
setName(String name)
|
void |
setPropertyName(String propertyName)
|
void |
setRuleClass(Class<? extends ColumnAvailabilityRule> ruleClass)
|
void |
setSearchable(boolean searchable)
|
void |
setSortable(boolean sortable)
|
void |
setWidth(int width)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractColumnDefinition()
Method Detail |
---|
public String getPropertyName()
getPropertyName
in interface ColumnDefinition
public void setPropertyName(String propertyName)
public String getName()
getName
in interface ColumnDefinition
public void setName(String name)
public int getWidth()
ColumnDefinition.getExpandRatio()
.
Default value is -1, meaning no explicit width assigned.
getWidth
in interface ColumnDefinition
public void setWidth(int width)
public String getLabel()
getLabel
in interface ColumnDefinition
public void setLabel(String label)
public boolean isSortable()
isSortable
in interface ColumnDefinition
public void setSortable(boolean sortable)
public Class<? extends ColumnFormatter> getFormatterClass()
getFormatterClass
in interface ColumnDefinition
public void setFormatterClass(Class<? extends ColumnFormatter> formatterClass)
public Class<?> getType()
getType
in interface ColumnDefinition
public boolean isDisplayInChooseDialog()
true
.
isDisplayInChooseDialog
in interface ColumnDefinition
public void setDisplayInChooseDialog(boolean displayInChooseDialog)
public float getExpandRatio()
ColumnDefinition.getWidth()
) or with natural width (no width nor expand
ratio).
Default value is 1.0.
getExpandRatio
in interface ColumnDefinition
public void setExpandRatio(float expandRatio)
public boolean isSearchable()
true
by default.
By default returns true
.
isSearchable
in interface ColumnDefinition
public void setSearchable(boolean searchable)
public boolean isEditable()
ColumnDefinition
isEditable
in interface ColumnDefinition
WorkbenchDefinition.isEditable()
public void setEditable(boolean editable)
public boolean isEnabled()
ColumnDefinition
isEnabled
in interface ColumnDefinition
public void setEnabled(boolean enabled)
public Class<? extends ColumnAvailabilityRule> getRuleClass()
ColumnDefinition
getRuleClass
in interface ColumnDefinition
public void setRuleClass(Class<? extends ColumnAvailabilityRule> ruleClass)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |