OverviewSingleDeprecated

jsx3.gui

interface Matrix.EditMask

jsx3.gui.Matrix.EditMask
interface Matrix.EditMask
The interface defining the methods that affect the behavior of an object used as an edit mask in a matrix column.

If an object is placed in the DOM as a child of a matrix column, it will be used as an edit mask. Any methods in this interface that the object does not implement will be inserted into the object. This interface is a "loose" interface because the class of an edit mask does not need to implement it in its class declaration. The class simply needs to define any methods whose default behavior it wishes to override.

Any edit mask that implements the jsx3.gui.Form interface will have the methods in this interface inserted into it. If the edit mask does not implement jsx3.gui.Form but extends jsx3.gui.Block, the methods in the jsx3.gui.Matrix.BlockMask interface are inserted instead.

Since:

3.2

See Also:

jsx3.gui.Matrix.BlockMask
Method Summary
void
commitEditMask(objEvent : jsx3.gui.Event, bKeepOpen : boolean)
Commits the current edit session of this edit mask.
boolean
emBeginEdit(strValue : String, objTdDim : Object<String, int>, objPaneDim : Object<String, int>, objMatrix : jsx3.gui.Matrix, objColumn : jsx3.gui.Matrix.Column, strRecordId : String, objTD : HTMLElement)
Called whenever an edit session begins.
String
emEndEdit()
Called when the current edit session ends.
Object<String, Object>
emGetSession()
Returns the state of the current edit session if this object is involved in a jsx3.gui.Matrix edit mask session.
String
emGetValue()
Returns the current value stored in the edit mask.
void
emInit(objColumn : jsx3.gui.Matrix.Column)
This method is called once when the edit mask is discovered by the matrix column to give it an opportunity to initialize itself.
void
resumeEditSession()
Resumes an edit session so that the edit session will close the next time this mask loses focus.
void
suspendEditSession()
Suspends an edit session so that if this mask loses focus, the edit session does not close.
Method Detail

commitEditMask

void commitEditMask(objEvent : jsx3.gui.Event, bKeepOpen : boolean)
Commits the current edit session of this edit mask.

Parameters:

objEvent – the wrapped browser event that logically caused this commit to occur. If this parameter is provided then all the model events related to committing an edit session are triggered.
bKeepOpen – if true then the current value of this edit mask is committed without closing the current edit session.

emBeginEdit

boolean emBeginEdit(strValue : String, objTdDim : Object<String, int>, objPaneDim : Object<String, int>, objMatrix : jsx3.gui.Matrix, objColumn : jsx3.gui.Matrix.Column, strRecordId : String, objTD : HTMLElement)
Called whenever an edit session begins.

Parameters:

strValue –
objTdDim –
objPaneDim –
objMatrix –
objColumn –
strRecordId –
objTD –

Returns:

false to cancel the edit session.  

emEndEdit

String emEndEdit()
Called when the current edit session ends. This method should return the edited value.

Returns:

the edited value.  

emGetSession

final Object<String, Object> emGetSession()
Returns the state of the current edit session if this object is involved in a jsx3.gui.Matrix edit mask session. The state has the following keys:

Returns:

the edit session. 

emGetValue

String emGetValue()
Returns the current value stored in the edit mask.

Returns:

the current value of the edit mask.  

emInit

void emInit(objColumn : jsx3.gui.Matrix.Column)
This method is called once when the edit mask is discovered by the matrix column to give it an opportunity to initialize itself.

Parameters:

objColumn – the matrix column parent.

resumeEditSession

final void resumeEditSession()
Resumes an edit session so that the edit session will close the next time this mask loses focus.

suspendEditSession

final void suspendEditSession()
Suspends an edit session so that if this mask loses focus, the edit session does not close.
Copyright © 2001-2007, TIBCO Software Inc.