|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.plumtree.uiinfrastructure.editor.EditorModel
public abstract class EditorModel
This is the Model class for the Editor Framework. Model classes should extend this class.
| Field Summary | |
|---|---|
AActivitySpace |
m_asOwner
Associated Activity Space |
protected boolean |
m_bCloseOnDone
JF- If this is true, the framework will close the window on finish and cancel. |
protected boolean |
m_bDeleteOnCancel
JF- This is for sub editors. |
protected boolean |
m_bEnableApplyButton
JF- The Apply button next to the finish button is optional |
protected boolean |
m_bHideLeftNav
JF- This is to hide the left navigation |
protected boolean |
m_bIsEditorReadOnly
JF- If the user only has read access to the Editor. |
protected boolean |
m_bUserHasAccessToEditor
JF- Is true if the current user has access to this Editor. |
protected int |
m_nEditorType
JF- This is the Editor type. |
| Constructor Summary | |
|---|---|
EditorModel()
|
|
| Method Summary | |
|---|---|
void |
Cancel()
Implement some code to execute when the user clicks on "Cancel". |
abstract boolean |
CheckEditorAccessAndStart(XPHashtable _htFormData)
Implements some actions to perform on start. |
void |
CleanupAllData()
This method is called when an ActivitySpace is removed from the cache. |
void |
CleanupTempData()
This method is called at the end of every HTTP request by the Interpreter. |
abstract java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
void |
DoTaskAfterStore()
That method contains the code that should be executed just after the object has been stored in the DB. |
void |
DoTaskBeforeStore()
That method contains the code that should be executed just before the object is stored in the DB. |
void |
DoTaskOnChangePage(java.lang.String _sNewSpaceName,
java.lang.String _sNewPageName)
This method can be implemented by classes extending this one. |
void |
DoTaskOnComeBackFromSubEditor()
This method will be called when you come back to the main Editor from a sub Editor. |
void |
DoTaskOnStartEditor(XPHashtable _htFormData)
That method contains the code that should be executed just after the object has been initialized when the new editor is started. |
abstract void |
Finish()
Implement some code to execute when the user clicks on "Finish". |
boolean |
GetCloseOnDone()
Returns the CloseOnDone flag. |
int |
GetCurrentRepostAction()
Returns the current value of the repost action. |
boolean |
GetDeleteOnCancel()
Returns the DeleteOnCancel flag. |
int |
GetEditorType()
Returns the Editor Type (see EditorStartControl for constant names). |
boolean |
GetEnableApplyButton()
Returns true if the apply button should be displayed. |
boolean |
GetHideLeftNav()
Returns the DeleteOnCancel flag. |
boolean |
GetIsEditorReadOnly()
Returns true if the current user only has read access to this Editor. |
abstract java.lang.String |
GetName()
Returns the Class name. |
Redirect |
GetRedirectAfterFinish()
Returns the Redirect object (this is were we need to go at the end of the Editor). |
boolean |
GetUserHasAccessToEditor()
Returns true if the current user has access to this Editor. |
void |
Init(AActivitySpace parent)
Inits the Model with the Activity Space. |
abstract int |
SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument. |
void |
SetCloseOnDone(boolean _bCloseOnDone)
To tell the framework to close the window on finish or cancel. |
void |
SetDeleteOnCancel(boolean _bDeleteOnCancel)
Sets the DeleteOnCancel flag. |
void |
SetEditorType(int _nEditorType)
Sets the Editor Type. |
void |
SetEnableApplyButton(boolean _bEnableApplyButton)
Enables or disables the apply button next to the finish button. |
void |
SetHideLeftNav(boolean _bHideLeftNav)
Sets the m_bHideLeftNav flag. |
void |
SetPageStatus(int _nNewPageStatus)
Sets a new Page status. |
void |
SetUserHasAccessToEditor(boolean _bUserHasAccessToEditor)
Sets a new value for the m_bUserHasAccessToEditor flag. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public AActivitySpace m_asOwner
protected boolean m_bDeleteOnCancel
protected boolean m_bCloseOnDone
protected boolean m_bHideLeftNav
protected boolean m_bIsEditorReadOnly
protected boolean m_bUserHasAccessToEditor
protected boolean m_bEnableApplyButton
protected int m_nEditorType
| Constructor Detail |
|---|
public EditorModel()
| Method Detail |
|---|
public abstract java.lang.Object Create()
Create in interface IManagedObjectpublic abstract java.lang.String GetName()
GetName in interface IMVCObjectpublic void Cancel()
public abstract boolean CheckEditorAccessAndStart(XPHashtable _htFormData)
_htFormData -
public abstract void Finish()
Finish in interface IRepostModelpublic void DoTaskAfterStore()
public void DoTaskBeforeStore()
public int GetCurrentRepostAction()
public boolean GetDeleteOnCancel()
public boolean GetCloseOnDone()
public int GetEditorType()
GetEditorType in interface IEditorModelROGetEditorType()public boolean GetEnableApplyButton()
GetEnableApplyButton in interface IEditorModelROGetEnableApplyButton()public void SetEnableApplyButton(boolean _bEnableApplyButton)
_bEnableApplyButton - public boolean GetHideLeftNav()
GetHideLeftNav in interface IEditorModelROGetHideLeftNav()public boolean GetIsEditorReadOnly()
GetIsEditorReadOnly in interface IEditorModelROGetIsEditorReadOnly()public Redirect GetRedirectAfterFinish()
GetRedirectAfterFinish in interface IRepostModelpublic boolean GetUserHasAccessToEditor()
public void Init(AActivitySpace parent)
Init in interface IModelparent -
public abstract int SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
SavePage in interface IRepostModel_sPageName - _htFormData -
public void CleanupTempData()
IModel
CleanupTempData in interface IModelIModel.CleanupTempData()public void CleanupAllData()
IModel
CleanupAllData in interface IModelIModel.CleanupAllData()
public void DoTaskOnChangePage(java.lang.String _sNewSpaceName,
java.lang.String _sNewPageName)
_sNewSpaceName - _sNewPageName - public void DoTaskOnComeBackFromSubEditor()
public void DoTaskOnStartEditor(XPHashtable _htFormData)
_htFormData - public void SetDeleteOnCancel(boolean _bDeleteOnCancel)
_bDeleteOnCancel - public void SetCloseOnDone(boolean _bCloseOnDone)
_bCloseOnDone - public void SetEditorType(int _nEditorType)
_nEditorType - public void SetHideLeftNav(boolean _bHideLeftNav)
_bHideLeftNav - public void SetPageStatus(int _nNewPageStatus)
_nNewPageStatus - public void SetUserHasAccessToEditor(boolean _bUserHasAccessToEditor)
_bUserHasAccessToEditor -
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||