|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.info.LyTag
leon.info.LyInfo
leon.info.LyObjectInfo
leon.info.LyPreference
public final class LyPreference
This class represents a preference. It contains the following attributes : - the action on which the preference is performed, - the filter used by the preference, - the sort used by the preference, - a name that may be displayed, - the fielInfo corresponding to the fixed column, - the owner of this preference.
LyObjectInfo
,
LyFilter
,
LySort
Nested Class Summary | |
---|---|
static class |
LyPreference.ShowAs
|
Nested classes/interfaces inherited from class leon.info.LyTag |
---|
LyTag.Model |
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
Fields inherited from class leon.info.LyObjectInfo |
---|
NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL |
Constructor Summary | |
---|---|
LyPreference(java.lang.String id,
LyObjectInfo objectInfo,
java.lang.String name,
LyFieldInfo fixedColumn,
int nbObjects,
java.lang.String user,
boolean defaultPref)
Constructor for a preference. |
Method Summary | |
---|---|
LyPreference |
clonePreference()
Clone a preference. |
LyPreference |
clonePreference(java.lang.String id)
Clone a preference. |
boolean |
deleteFile()
Method for deleting preference file. |
void |
free()
Method for freeing extra info (and sub-infos). |
java.lang.String |
getColumnSizes()
Get size of columns of this preference. |
LyInfoList<LyFieldInfo> |
getFieldInfos()
Gets list of field infos of this preference. |
LyFilter |
getFilter()
Get filter used by this preference. |
LyFieldInfo |
getFixedColumn()
Get the field info for which its column is fixed in this preference. |
java.lang.String |
getLastFileName()
This method return the name of the last open file name (only for import). |
int |
getNbObjects()
Get the number of displayed objects. |
LyObjectInfo |
getObjectInfo()
Get object info referred by this preference. |
java.lang.String |
getObjectInfoId()
Get object info referred by this preference. |
LyPreference.ShowAs |
getShowAs()
Get the display mode of this preference. |
LySort |
getSort()
Get sort used by this preference. |
java.lang.String |
getUser()
Get owner of this preference. |
boolean |
isDefault()
Checks if this preference is the default one or not. |
boolean |
isDefaultForMobile()
Checks if this preference is the default one or not for mobile view. |
boolean |
isForPortlet()
Checks if this preference is for portlet only. |
boolean |
isReadOnly()
Checks if this preference can be changed or not. |
boolean |
saveFile(LyXmlWriterInterface writer)
Method for saving preference file. |
void |
setColumnSizes(java.lang.String columnSizes)
Sets the size of the columns for this preference. |
void |
setDefault(boolean defaultPref)
Sets whether this preference is the default one or not. |
void |
setDefaultForMobile(boolean defaultForMobile)
Sets whether this preference is the default one or not for mobile view. |
void |
setFieldInfos(LyInfoList<LyFieldInfo> fieldInfos)
Sets list of field infos of this preference. |
void |
setFilter(LyFilter filter)
Get filter used by this preference. |
void |
setFixedColumn(LyFieldInfo fixedColumn)
set the field info for which its column is fixed in this preference. |
void |
setForPortlet(boolean forPortlet)
Sets whether this preference is for portlet only. |
void |
setLastFileName(java.lang.String fileName)
This method set the name of the last open file name (only for import). |
void |
setNbObjects(int nbObjects)
Set the number of displayed objects. |
void |
setObjectInfo(LyObjectInfo objectInfo)
Sets the object info referred by this preference. |
void |
setReadOnly(boolean readOnly)
Sets whether this preference can be changed or not. |
void |
setShowAs(LyPreference.ShowAs showAs)
Sets the display mode of this preference. |
void |
setSort(LySort sort)
Get sort used by this preference. |
void |
writeXml(java.io.PrintWriter pw)
Writes XML corresponding to this filter element. |
void |
writeXml(java.io.PrintWriter pw,
boolean header,
boolean body)
Method to rewrite XML corresponding to this component. |
Methods inherited from class leon.info.LyObjectInfo |
---|
clone, getAlias, getData, getDataList, getDatas, getFilePrefix, getGroup, getInternalAlias, getInternalFilePrefix, getInternalName, getMarks, getName, getTemplate, getTip, getUserData, hasMark, hasMarks, hasTemplate, isTemplate, putData, putData, removeData, toName |
Methods inherited from class leon.info.LyInfo |
---|
getApplication, getFile, getId, getInclude, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString |
Methods inherited from class leon.info.LyTag |
---|
getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface leon.info.infointerface.LyExtraInfoInterface |
---|
getFile, setFile |
Methods inherited from interface leon.parser.LyCommentInterface |
---|
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart |
Field Detail |
---|
public static final java.lang.String __VERSION
Constructor Detail |
---|
public LyPreference(java.lang.String id, LyObjectInfo objectInfo, java.lang.String name, LyFieldInfo fixedColumn, int nbObjects, java.lang.String user, boolean defaultPref)
id
- the identifier of the preference.classInfo
- the concerned object info.name
- the name of the preference.fixedColumn
- field info for which its column is fixed for the preference.nbObjects
- number of displayed objects.user
- the id of the user that owns the preference.defaultPref
- indicates if this preference is the default one.Method Detail |
---|
public LyPreference clonePreference()
public LyPreference clonePreference(java.lang.String id)
id
- identifier of the cloned preference.public void free()
free
in interface LyExtraInfoInterface
public boolean saveFile(LyXmlWriterInterface writer)
saveFile
in interface LyExtraInfoInterface
public boolean deleteFile()
deleteFile
in interface LyExtraInfoInterface
public void writeXml(java.io.PrintWriter pw, boolean header, boolean body)
writeXml
in interface LyExtraInfoInterface
pw
- The printWriter on which the XML is written.header
- Boolean indicating if header must be written.header
- Boolean indicating if body must be written.public void writeXml(java.io.PrintWriter pw)
writeXml
in interface LyExtraInfoInterface
pw
- PrintWriter on which the XML is written.public LyObjectInfo getObjectInfo()
public java.lang.String getObjectInfoId()
public LyFilter getFilter()
public LySort getSort()
public LyFieldInfo getFixedColumn()
public int getNbObjects()
public boolean isDefault()
public boolean isDefaultForMobile()
public boolean isForPortlet()
public boolean isReadOnly()
public LyInfoList<LyFieldInfo> getFieldInfos()
public java.lang.String getUser()
getUser
in interface LyExtraInfoInterface
public java.lang.String getColumnSizes()
public LyPreference.ShowAs getShowAs()
public void setObjectInfo(LyObjectInfo objectInfo)
action
- Object info concerned by this preference.public void setFixedColumn(LyFieldInfo fixedColumn)
fixedColumn
- Field info for which its column is fixed in this preference.public void setNbObjects(int nbObjects)
nbObjects
- number of displayed objects, 0 if not set.public void setDefault(boolean defaultPref)
defaultPref
- True if default preference, false otherwise.public void setDefaultForMobile(boolean defaultForMobile)
defaultPref
- True if default preference for mobile, false otherwise.public void setForPortlet(boolean forPortlet)
forPortlet
- True if preference for portlet only, false otherwise.public void setReadOnly(boolean readOnly)
readOnly
- True if this preference can't be nor changed neither deleted, false
otherwise.public void setColumnSizes(java.lang.String columnSizes)
columnSizes
- the size of the columns for this preference.public void setFilter(LyFilter filter)
public void setSort(LySort sort)
public void setFieldInfos(LyInfoList<LyFieldInfo> fieldInfos)
fieldInfos
- List of field infos, may be null.public java.lang.String getLastFileName()
public void setLastFileName(java.lang.String fileName)
fileName
- public void setShowAs(LyPreference.ShowAs showAs)
showAs
- Display mode chose for this preference.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |