public class FieldArea
extends java.lang.Object
implements java.io.Serializable
Constructor and Description |
---|
FieldArea(java.lang.String id,
java.lang.String name,
java.lang.String display,
int position,
boolean titleVisible)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
addField(ObjectField f)
Adds a field to the area
|
java.lang.String |
getAreaId()
UI area Id
|
java.util.Vector<ObjectField> |
getDefaultFields()
Gets initial ordered fields
|
java.lang.String |
getDisplay()
Returns translated area title
|
ObjectField |
getField(int idx)
Gets field at specified index
|
ObjectField |
getField(int idx,
boolean defaultPos)
Gets field at specified index
|
java.util.Vector<ObjectField> |
getFields()
Gets fields in reordered positions
|
java.lang.String |
getIcon()
Get icon code
|
java.lang.String |
getId()
Returns unique id of the area
|
java.lang.String |
getName()
Returns functional name of the area
|
int |
getNbFields()
Returns the number of fields of the area
|
int |
getPosition()
Returns area position
|
java.lang.String |
getTabId()
Tab id if area belongs to a multi-tabs panel
|
int |
getTabPos() |
java.lang.String |
getTemplate()
Area HTML template (if null, display field in one column)
|
boolean |
isTitleVisible()
Returns whether title is to be displayed or not
|
boolean |
isVisible()
Returns whether area is to be displayed or not
|
static FieldArea |
load(ObjectDB obj,
int num)
Load the field area definition from repository
|
void |
moveField(int from,
int to)
Change field ordering
|
void |
removeField(ObjectField f)
Removes field from the area
|
void |
removeFields()
Removes all fields from the area
|
void |
restoreFields()
Restore fields in initial positions
|
void |
setAreaId(java.lang.String areaId) |
void |
setDisplay(java.lang.String disp) |
void |
setIcon(java.lang.String code) |
void |
setId(java.lang.String id) |
void |
setName(java.lang.String name) |
void |
setPosition(int p) |
void |
setTab(java.lang.String tabId,
int pos) |
void |
setTemplate(java.lang.String template) |
void |
setTitleVisible(boolean b) |
void |
setVisible(boolean b) |
java.lang.String |
toString()
Generates basic string dump for field area (useful for debug purposes)
|
public FieldArea(java.lang.String id, java.lang.String name, java.lang.String display, int position, boolean titleVisible)
public java.lang.String getId()
public void setId(java.lang.String id)
public java.lang.String getName()
public void setName(java.lang.String name)
public java.lang.String getDisplay()
public void setDisplay(java.lang.String disp)
public int getPosition()
public void setPosition(int p)
public boolean isTitleVisible()
public void setTitleVisible(boolean b)
public boolean isVisible()
public void setVisible(boolean b)
public java.lang.String getIcon()
public void setIcon(java.lang.String code)
public java.lang.String getTabId()
public int getTabPos()
public void setTab(java.lang.String tabId, int pos)
public java.lang.String getAreaId()
public void setAreaId(java.lang.String areaId)
public java.lang.String getTemplate()
public void setTemplate(java.lang.String template)
public void addField(ObjectField f)
f
- Field to addpublic void removeField(ObjectField f)
f
- Field to removepublic void removeFields()
public ObjectField getField(int idx)
idx
- Indexpublic ObjectField getField(int idx, boolean defaultPos)
idx
- IndexdefaultPos
- Default or reordered positionspublic java.util.Vector<ObjectField> getFields()
public java.util.Vector<ObjectField> getDefaultFields()
public void restoreFields()
public void moveField(int from, int to)
from
- from position indexto
- to position indexpublic int getNbFields()
public static FieldArea load(ObjectDB obj, int num)
obj
- Objectnum
- Area positionpublic java.lang.String toString()
Generates basic string dump for field area (useful for debug purposes)
toString
in class java.lang.Object
Copyright (c)2006-2014 Simplicite Software. All Rights Reserved.