java.lang.Objecttelosys.objects.Screen
Screen object
This object is designed to manage the current screen
NB : Many of its methods are not supposed to be used directly by the application
Constructor Summary | |
protected |
Screen(string sreenName,
string ajaxUrl)
Constructor The screen id is "0" |
protected |
Screen(string sreenName,
string ajaxUrl,
number screenId)
Constructor |
Method Summary | |
boolean |
CheckAllFields()
Checks all fields of the screen |
boolean |
CheckField(object oField)
Checks a specific field |
void |
clear(string sZone)
Clears all fields of the screen or of the given screen zone (can be null) |
void |
clearField(object oField)
Clears the given field |
void |
clearViews(string sZone)
Clears all views of the screen or of the given screen zone (can be null) |
void |
close()
Deprecated. |
void |
desc()
Shows (alert) a description of the screen |
void |
disable(string sZone)
Disables all the screen or the given screen zone (can be null) |
void |
enable(string sZone)
Enables all the screen or the given screen zone (can be null) |
void |
Exit()
Deprecated. |
string |
getElementsString()
Returns a string with all elements of the screen |
string |
getRequestURL()
Returns the URL use to send the requests |
number |
getScreenId()
Returns the screen id |
string |
getScreenName()
Returns the screen name |
ScreenView[] |
getViews()
Returns an array with all views of the screen |
void |
OnLoad()
Deprecated. |
void |
RegisterCheckBox(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr,
string sValOn,
string sValOff)
Registers a checkbox |
void |
RegisterComboBox(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr)
Registers a combobox |
object |
RegisterField(string sFieldId,
string sScreenZone,
string sXmlTag,
string sXmlAttr)
Registers a field |
void |
RegisterFieldDate(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr,
string sFormat)
Registers a date field |
void |
RegisterHidden(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr)
Registers ... |
void |
RegisterHtmlViewer(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr)
Registers a html viewer |
void |
RegisterListBox(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr)
Registers a listbox |
void |
RegisterRadioGroup(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr,
string[] aRadioIds)
Registers a radio group |
void |
RegisterRichTextEditor(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr)
Registers a rich text editor |
void |
RegisterTextArea(string sId,
string sScreenZone,
string sXmlTag,
string sXmlAttr)
Registers a text area |
object |
RegisterView(string sContainerId,
string sScreenZone,
string sXmlTag,
string sRenderer)
Registers a view |
string |
ScreenToXml(string argElementName)
Returns the xml description of the given element |
void |
setDisabled(boolean bFlagDisabled,
string sZone)
Sets disabled all screen or the given screen zone (can be null) |
void |
setFieldDisabled(object oField,
java.lang.Boolean bFlag)
Sets enable/disable the field |
void |
setParametersFromFields(Map paramMap)
Populates the given map with the value of each field declared in the screen map[xmlAttribute] = fieldValue |
void |
setParametersFromFields(Map paramMap,
string elementName)
Populates the given map with the values of the fields belonging to the given element name map[xmlAttribute] = fieldValue |
void |
setTrace(boolean flag)
Set the "trace" flag |
void |
XmlToScreen(object oResponse)
Populates the fields and views of the screen with XML data received |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected Screen(string sreenName, string ajaxUrl)
sreenName
- : name of the screenajaxUrl
- : URL for AJAX actions requestsprotected Screen(string sreenName, string ajaxUrl, number screenId)
sreenName
- : name of the screenajaxUrl
- : URL for AJAX actions requestsscreenId
- : id of the screen ( 0 to N )Method Detail |
public string getScreenName()
public number getScreenId()
public string getRequestURL()
public string getElementsString()
public ScreenView[] getViews()
public string ScreenToXml(string argElementName)
argElementName
- the element name
public void XmlToScreen(object oResponse)
oResponse
- the server response objectpublic object RegisterView(string sContainerId, string sScreenZone, string sXmlTag, string sRenderer)
sContainerId
- the container idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tag ("view" attribute)sRenderer
- the renderer to use ("renderer" attribute)
public object RegisterField(string sFieldId, string sScreenZone, string sXmlTag, string sXmlAttr)
sFieldId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
-
public void RegisterFieldDate(string sId, string sScreenZone, string sXmlTag, string sXmlAttr, string sFormat)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- sFormat
- the date formatpublic void RegisterHidden(string sId, string sScreenZone, string sXmlTag, string sXmlAttr)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- public void RegisterComboBox(string sId, string sScreenZone, string sXmlTag, string sXmlAttr)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- public void RegisterListBox(string sId, string sScreenZone, string sXmlTag, string sXmlAttr)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- public void RegisterCheckBox(string sId, string sScreenZone, string sXmlTag, string sXmlAttr, string sValOn, string sValOff)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- sValOn
- the on valuesValOff
- the off valuepublic void RegisterRadioGroup(string sId, string sScreenZone, string sXmlTag, string sXmlAttr, string[] aRadioIds)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- aRadioIds
- the list of id (an array)public void RegisterTextArea(string sId, string sScreenZone, string sXmlTag, string sXmlAttr)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- public void RegisterRichTextEditor(string sId, string sScreenZone, string sXmlTag, string sXmlAttr)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- public void RegisterHtmlViewer(string sId, string sScreenZone, string sXmlTag, string sXmlAttr)
sId
- the field idsScreenZone
- the screen zone ("zone" attribute)sXmlTag
- the xml tagsXmlAttr
- public void clearField(object oField)
oField
- the field referencepublic void setFieldDisabled(object oField, java.lang.Boolean bFlag)
oField
- the field referencebFlag
- true(enable) | false(disable)public void clearViews(string sZone)
sZone
- the screen zone (can be null)public void clear(string sZone)
sZone
- the screen zone (can be null)public void enable(string sZone)
sZone
- the screen zone (can be null)public void disable(string sZone)
sZone
- the screen zone (can be null)public void setDisabled(boolean bFlagDisabled, string sZone)
bFlagDisabled
- true(enable) | false(disable)sZone
- the screen zone (can be null)public void desc()
public void OnLoad()
public void Exit()
public void close()
public boolean CheckField(object oField)
oField
- the field reference
public boolean CheckAllFields()
public void setTrace(boolean flag)
flag
- public void setParametersFromFields(Map paramMap, string elementName)
paramMap
- the map to populateelementName
- the name of the elementpublic void setParametersFromFields(Map paramMap)
paramMap
- the map to populate