LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.control
Interface LyFormInterface

All Superinterfaces:
LyControllerContextInterface
All Known Implementing Classes:
LyCreateController, LyCreateOrSetController, LyEditTableSetController, LyRelationTableController, LySetController

public interface LyFormInterface
extends LyControllerContextInterface

This interface is provided to allow sub form controllers to be called when the form is validated or cancelled.


Field Summary
static java.lang.String __VERSION
          File Version
static short STATUS_CANCEL
          Return codes for validate: Cancel
static short STATUS_IGNORE
          Return codes for validate: Ignore
static short STATUS_KO
          Return codes for validate: KO
static short STATUS_OK
          Return codes for validate: OK
 
Method Summary
 void cancel()
          Method called when the parent form is cancelled.
 boolean checkIfModified()
          Checks if changes were done on current edition.
 void commit()
          Method called when the whole modifications are committed.
 short control()
          Method for controlling current edition.
 short endValidate()
          Method called at the end of the parent form validation to complete the edition.
 LyValue getFieldValue(LyFieldInfo fieldInfo)
          Extract current value for the specified fieldInfo in the form.
 void setEditable(boolean editable)
          Set boolean indicating if the controlled form is editable or not.
 void setEnabled(boolean enabled)
          Set boolean indicating if the controlled form is enabled or not.
 short startValidate()
          Method called at the begining of the parent form validation to check if everything is ok before completing the edition.
 
Methods inherited from interface leon.control.LyControllerContextInterface
getControllerContext
 

Field Detail

__VERSION

static final java.lang.String __VERSION
File Version

See Also:
Constant Field Values

STATUS_CANCEL

static final short STATUS_CANCEL
Return codes for validate: Cancel

See Also:
Constant Field Values

STATUS_IGNORE

static final short STATUS_IGNORE
Return codes for validate: Ignore

See Also:
Constant Field Values

STATUS_OK

static final short STATUS_OK
Return codes for validate: OK

See Also:
Constant Field Values

STATUS_KO

static final short STATUS_KO
Return codes for validate: KO

See Also:
Constant Field Values
Method Detail

startValidate

short startValidate()
Method called at the begining of the parent form validation to check if everything is ok before completing the edition.

Returns:
One of the status codes indicating if the validation was done (STATUS_OK), if an error occured (STATUS_KO), or if nothing was done by the user (STATUS_IGNORE).

endValidate

short endValidate()
Method called at the end of the parent form validation to complete the edition.

Returns:
One of the status codes indicating if the validation was complete (STATUS_OK), if an error occured (STATUS_KO), or if nothing was done by the user (STATUS_IGNORE).

commit

void commit()
Method called when the whole modifications are committed.


cancel

void cancel()
Method called when the parent form is cancelled.


control

short control()
Method for controlling current edition.

Returns:
Error status.

checkIfModified

boolean checkIfModified()
Checks if changes were done on current edition.

Returns:
true if the edition was changed, false otherwise.

getFieldValue

LyValue getFieldValue(LyFieldInfo fieldInfo)
Extract current value for the specified fieldInfo in the form.

Parameters:
fieldInfo - fieldInfo associated to the requested value
Returns:
current value, or null if not found or field is disabled.

setEditable

void setEditable(boolean editable)
Set boolean indicating if the controlled form is editable or not.

Parameters:
editable - editable status.

setEnabled

void setEnabled(boolean enabled)
Set boolean indicating if the controlled form is enabled or not.

Parameters:
enabled - enabled status.

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com