Uiinfrastructure API Docs  
 

EditorModel Members

EditorModel overview

Public Instance Fields

m_asOwner Associated Activity Space

Public Instance Methods

Cancel Implement some code to execute when the user clicks on "Cancel".
CheckEditorAccessAndStart Implements some actions to perform on start. Use the Editor Type if needed.
CleanupAllData 
CleanupTempData 
Create This method is used by the ASManager to return new instances of managed objects.
DoTaskAfterStore That method contains the code that should be executed just after the object has been stored in the DB.
DoTaskBeforeStore That method contains the code that should be executed just before the object is stored in the DB.
DoTaskOnChangePage This method can be implemented by classes extending this one. It will be executed each time the user changes page on the left navigation menu.
DoTaskOnComeBackFromSubEditor This method will be called when you come back to the main Editor from a sub Editor.
DoTaskOnStartEditor That method contains the code that should be executed just after the object has been initialized when the new editor is started.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
Finish Implement some code to execute when the user clicks on "Finish".
GetCloseOnDone Returns the CloseOnDone flag.
GetCurrentRepostAction Returns the current value of the repost action.
GetDeleteOnCancel Returns the DeleteOnCancel flag. For sub Editors only: this flag will determine if the Editor should be deleted from the list of sub Editors on cancel.
GetEditorType Returns the Editor Type (see EditorStartControl for constant names).
GetEnableApplyButton Returns true if the apply button should be displayed.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetHideLeftNav Returns the DeleteOnCancel flag. For sub Editors only: this flag will determine if the Editor should be deleted from the list of sub Editors on cancel.
GetIsEditorReadOnly Returns true if the current user only has read access to this Editor. (can be true in Edit mode only)
GetName Returns the Class name.
GetRedirectAfterFinish Returns the Redirect object (this is were we need to go at the end of the Editor). By default this is going to the previous AS (the one that opened this one). But Editors can override that method if they need to redirect somewhere else.
GetType (inherited from Object)Gets the Type of the current instance.
GetUserHasAccessToEditor Returns true if the current user has access to this Editor. (If false the user will be redirected.)
Init Inits the Model with the Activity Space.
SavePage Calls the right save function according to the page name passed in argument.
SetCloseOnDone To tell the framework to close the window on finish or cancel.
SetDeleteOnCancel Sets the DeleteOnCancel flag. For sub Editors only: this flag will determine if the Editor should be deleted from the list of sub Editors on cancel.
SetEditorType Sets the Editor Type. (see EditorStartControl for constant names)
SetEnableApplyButton Enables or disables the apply button next to the finish button.
SetHideLeftNav Sets the m_bHideLeftNav flag. If this flag is set to true, the left navigation will not be displayed.
SetPageStatus Sets a new Page status.
SetUserHasAccessToEditor Sets a new value for the m_bUserHasAccessToEditor flag.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Constructors

EditorModel Constructor Initializes a new instance of the EditorModel class.

Protected Instance Fields

m_bCloseOnDone JF- If this is true, the framework will close the window on finish and cancel.
m_bDeleteOnCancel JF- This is for sub editors. The first time we access the Editor, if the user clicks on cancel, we want to delete it from the sub Editor list.
m_bEnableApplyButton JF- The Apply button next to the finish button is optional
m_bHideLeftNav JF- This is to hide the left navigation
m_bIsEditorReadOnly JF- If the user only has read access to the Editor.
m_bUserHasAccessToEditor JF- Is true if the current user has access to this Editor.
m_nEditorType JF- This is the Editor type. Constants for that variable are in EditorStartControl. This is mainly to know if it's create or edit mode.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

EditorModel Class | com.plumtree.uiinfrastructure.editor Namespace