<F_MARKS> : Field marks

ROLE

Field marks enable to define properties to the fields of a class in order to generate a common behavior inside the application.

ATTRIBUTES

<!ATTLIST F_MARKS
	  condition CDATA #IMPLIED
	  operation ( RESET | CLEAR | AND | OR | XOR) "OR"
	  id ( true | false) "false"
	  appId ( true | false) "false"
	  name ( true | false) "false"
	  create ( true | false) "false"
	  set ( true | false) "false"
	  main ( true | false) "false"
	  table ( true | false) "false"
	  sort ( true | false) "false"
	  filter ( true | false) "false"
	  find ( true | false) "false"
	  secret ( true | false) "false"
	  notNull ( true | false) "false"
	  optional ( true | false) "false"
	  private ( true | false) "false"
	  unique ( true | false) "false"
	  status ( true | false) "false"
	  local ( true | false) "false"
	  consult ( true | false) "false"
	  createConsult ( true | false) "false"
	  setConsult ( true | false) "false"
	  needPost ( true | false) "false"
	  chart ( true | false) "false"
	  readOnly ( true | false) "false"
	  disable ( true | false) "false"
	  hidden ( true | false) "false"
	  load ( true | false) "false"
	  providerValue ( true | false) "false"
	  complexTable ( true | false) "false"
	  search ( true | false) "false"
	  autoCompletion ( true | false) "false"
	  translate ( true | false) "false"
	  noCaption ( true | false) "false">
Attribute Mand. Description Default
condition no The value of this attribute enables to control the existence of this list of marks (see 'Using marks' chapter)  
operation no Method used to merge list of action marks (see 'Using marks' chapter) OR
id no When this generic mark equals true, the values associated to this field are part of the internal identifier of the objects of the related class. The identifier of an object is composed of the values of the id fields of its class. The default separator used is the comma (','). For example, it is convenient to have key columns inside a database bound to id fields. false
appId no This attribute defines a secondary key that must be unique within a class. The secondary identifier of an object is the concatenation of the values of the fields with this mark separated by a character (default character is ','). false
name no When this generic mark equals true, the values associated to this field are part of the name of the objects of the related class. The name of an object, which is the string displayed throughout the graphical user interface, is composed of the values of the name fields of its class. The default separator used is the backslash (''). false
create no When this generic mark is set to true, the field is inserted inside creation forms. false
set no When this generic mark is set to true, the field is inserted inside modification forms. false
main no This mark is a shortcut for defining in the same time table, sort, filter and find marks. false
table no When this generic mark is set to true, the field will define a column inside the table views. false
sort no When this generic mark is set to true, the field is allowed to be a sort criterion inside tables. The header of the field column is sensitive to user's actions and sets off a sort. false
filter no When this generic mark is set to true, the field can be selected inside filtering windows. false
find no When this generic mark is set to true, the field is allowed to be a research criterion. false
secret no When this generic mark is set to true, the selected values can't be visualized in any window nor printed. When selecting values inside a TEXT field that has this mark, a blind keyboarding is required. For example, this mark is useful for fields intended to contain a password. false
notNull no When this generic mark is set to true, the field requires a value. At the end of the creation of an object, if the field has not been filled in by the user, the default value will automatically be chosen before committing the result to the data provider.
Warning: this mark is distinct from the optional mark which ROLE is to enable an empty keyboarding of the field.
false
optional no When this generic mark is set to true, empty keyboarding for this field is allowed inside form windows. false
private no When this generic mark is set to true, the values for this field can't be copied. This avoid copying values when the clone action is executed or during the creation of a new object when the apply button is clicked. false
unique no When this generic mark is set to true, the selected value for this field should be unique. It is not permitted to set the same value for this field to several objects of the same class. The null value is not considered as a value and is not controlled for unicity. false
status no When this generic mark is set to true, the field is regarded as information about the state of objects. Each value of this field is associated to a symbolic image that will appear at the beginning of each row when a table view is displayed. The definition of the relation between values of the field and image files is made inside the application images property file. false
local no When this generic mark is set to true, this field is not bound to any physical data provider. Associated values are just kept inside the memory and discarded at the end of the session. false
consult no When this generic mark is set to true, the values of this field are displayed but not modifiable inside modification forms. false
createConsult no When this generic mark is set to true, the values of this field are displayed but not modifiable inside creation forms (it does make sense only if the concerned field is computed or imported). false
setConsult no When this generic mark is set to true, the values of this field are displayed but not modifiable inside modification forms. false
needPost no Specifies, when set to true, that this field requires a POST (in Web mode) when it is modified to allow its checking or to modify in the same time other fields of the same form.
For generic cases (formulas, contexts?), this feature is managed internally and doesn't require the setting of this mark.
false
chart no When this generic mark is set to true, the field is available when creating charts. false
readOnly no When this generic mark is set to true, the input field
corresponding to this field in a creation or a modification form is not editable at the opening of the form.
false
disable no When this generic mark is set to true, the input field
corresponding to this field in a creation or a modification form is disable at the opening of the form.
false
hidden no When this generic mark is set to true, the field is not shown in consultation forms that have no specific marks specified. false
load no Force loading of this field in query requests on which fields to load are not specified. false
providerValue no When this generic mark is set to true, the values of this field are given by the data provider. false
complexTable no When this generic mark is set to true, the field will define a column inside the complex table views. false
search no When this generic mark is set to true, the field will be displayed in the description of an object in search text views. false
autoCompletion no This marks activates auto-completion for the field (text and relation only). false
translate no Activates translation of attribute values (automatic for choices). false
noCaption no F_MARKS.noCaption false

ELEMENTS

<!ELEMENT F_MARKS 
	  (MARK |
	   F_MARK)*>
Element Mand. Mult. Description
MARK yes no Specific marks reserved for an applicative use
F_MARK yes no Used to add a generic mark restricted to an action.

SAMPLE

<!-- Those marks define a field that is visible inside creation and modification forms
	and has a specific mark named APP_CALCULATED -->

<F_MARKS create='true' set='true'>
	<MARK name="APP_CALCULATED"/>
</F_MARKS>