Uiinfrastructure API Docs  
 

EditorModel Members

EditorModel overview

Public Instance Fields

iconisReadAccessAvailable Setting to allow read access to all objects *
iconm_asOwner Associated Activity Space

Public Instance Methods

iconCancel Implement some code to execute when the user clicks on "Cancel".
iconCheckEditorAccessAndStart Implements some actions to perform on start. Use the Editor Type if needed.
iconCleanupAllData 
iconCleanupTempData 
iconCreate This method is used by the ASManager to return new instances of managed objects.
iconDoTaskAfterStore That method contains the code that should be executed just after the object has been stored in the DB.
iconDoTaskBeforeStore That method contains the code that should be executed just before the object is stored in the DB.
iconDoTaskOnChangePage 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.
iconDoTaskOnComeBackFromSubEditor This method will be called when you come back to the main Editor from a sub Editor.
iconDoTaskOnStartEditor That method contains the code that should be executed just after the object has been initialized when the new editor is started.
iconEquals (inherited from Object)Determines whether the specified Object is equal to the current Object.
iconFinish Implement some code to execute when the user clicks on "Finish".
iconGetAccessToEditorPriviledges Gets the Read Access to editors without Edit permissions in the portal
iconGetCloseOnDone Returns the CloseOnDone flag.
iconGetCurrentRepostAction Returns the current value of the repost action.
iconGetDeleteOnCancel 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.
iconGetEditorType Returns the Editor Type (see EditorStartControl for constant names).
iconGetEnableApplyButton Returns true if the apply button should be displayed.
iconGetEnableCancelButton Returns true if the current user is able to cancel the Editor.
iconGetHashCode (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.
iconGetHideLeftNav 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.
iconGetIsEditorReadOnly Returns true if the current user only has read access to this Editor. (can be true in Edit mode only)
iconGetName Returns the Class name.
iconGetRedirectAfterFinish 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.
iconGetType (inherited from Object)Gets the Type of the current instance.
iconGetUserHasAccessToEditor Returns true if the current user has access to this Editor. (If false the user will be redirected.)
iconInit Inits the Model with the Activity Space.
iconSavePage Calls the right save function according to the page name passed in argument.
iconSetCloseOnDone To tell the framework to close the window on finish or cancel.
iconSetDeleteOnCancel 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.
iconSetEditorType Sets the Editor Type. (see EditorStartControl for constant names)
iconSetEnableApplyButton Enables or disables the apply button next to the finish button.
iconSetHideLeftNav Sets the m_bHideLeftNav flag. If this flag is set to true, the left navigation will not be displayed.
iconSetPageStatus Sets a new Page status.
iconSetUserHasAccessToEditor Sets a new value for the m_bUserHasAccessToEditor flag.
iconToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Constructors

icon EditorModel Constructor Initializes a new instance of the EditorModel class.

Protected Instance Fields

iconm_bCloseOnDone JF- If this is true, the framework will close the window on finish and cancel.
iconm_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.
iconm_bEnableApplyButton JF- The Apply button next to the finish button is optional
iconm_bEnableCancelButton JF- If the user should be able to cancel the editor.
iconm_bHideLeftNav JF- This is to hide the left navigation
iconm_bIsEditorReadOnly JF- If the user only has read access to the Editor.
iconm_bUserHasAccessToEditor JF- Is true if the current user has access to this Editor.
iconm_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

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

See Also

EditorModel Class | com.plumtree.uiinfrastructure.editor Namespace