Package com.dassault_systemes.pprnblcabase.controller

   
Class LCABaseController

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.pprnblcabase.controller.LCABaseController
Class Location

Framework : PPRJNavigatorBase

Module : PPRNBLcaBase

Class Description

public class LCABaseController

Provides generic controller services

Field Summary
protected String _className
protected CATDialog _dialog
protected String _document
protected Hashtable _parmTable
name value pairs parsed from _document
protected CATSession _session

Constructor Summary
LCABaseController()
Constructor for ControllerBase.

Method Summary
protected void addParameter(String iName, Object iValue, StringBuffer iDoc)
Helper routine to append a name/value pair to a document note: this method is not related to the "getParameter" in that it does not put a value into this objects parm table.
protected boolean ensureLogon()
This method will perfrom an automatic redirect to the logon page of the logon token is null.
protected ENOVIDataObject getDataObject(ENOVTypeMask iMask)
Returns the data object for the given uuid
protected ENOVIDataObject getDataObject(String iUUID)
protected ENOVIDataObject getDataObject(String iUUID, ENOVTypeMask iMask)
protected String getEnvValue(String iKey, String iDfltValue)
protected ENOVILogonToken getLogonToken()
protected String getObjectUUID()
Function to encapsulate accessing the UUID of the focal object.
protected Object getParameter(String iName)
Returns a parameter value parsed from the input document value.
protected Object getParameter(String iName, String iDefault)
Returns a parameter value parsed from the input document value.
protected String getStringValue(String iKey, String iDfltValue)
Returns the translated string or the key if no translation is found
protected String getStringValue(String iFile, String iKey, String iDfltValue)
Returns the translated string or the key if no translation is found
public String getWidgetID()
protected void init(CATDialog iDialog, CATNotification iNotification, Object iData)
Initializes the basic constructor values.
public void onCancel(CATDialog iDialog, CATNotification iNotification, Object iData)
public void onCreate(CATDialog iDialog, CATNotification iNotification, Object iData)
onCreate event handler which calls "init".
public void onDocumentChanged(CATDialog iDialog, CATNotification iNotification, Object iData)
onDocumentChanged event handler which calls init or reintOnDocChg as appropriate.
protected void parseDocument()
protected void processMessageForCATMessageArea(String statusMsgText, CATSession session, boolean ok)
protected void pushErrorMessage(String iMsgKey)
protected void pushMessage(String iMsgKey, int iSeverity)
protected void reinitOnDocChg()
ReInitializes the list of parameters passed to this dialog as the document value.
protected void setEnvValue(String iKey, String iValue)
public void setParameters(Hashtable iParms)
protected void showStatusMessage(Message iStatusMsg)
Displays the given status message with the current message stack for details.
protected void showStatusMessage(String iMsgKey, boolean iOk)
Displays the given status message.
protected void showStatusMessage(String iMsgFile, String iMsgKey, boolean iOk)
Displays the given status message with the current message stack for details.
protected void stack(String iCommand)
Calls another dialog, passing along all of the document parameters passed to this dialog.
protected void stack(String iCommand, String iDocument)
Calls another dialog, passing the input document parameters.
protected void stackReplace(String iCommand)
Calls another dialog, passing along all of the document parameters passed to this dialog.
protected CATDialog stackView(String iCommand, String iDocument)
Calls another dialog, passing the input document parameters.
protected void unstack()
Removes this dialog from the stack.


Field Detail

_className

    protected String _className


_dialog

    protected CATDialog _dialog


_document

    protected String _document


_parmTable

    protected Hashtable _parmTable
name value pairs parsed from _document


_session

    protected CATSession _session


Constructor Detail

LCABaseController

    LCABaseController()

Constructor for ControllerBase.


Method Detail

addParameter

    protected void addParameter(String iName, Object iValue, StringBuffer iDoc)

Helper routine to append a name/value pair to a document note: this method is not related to the "getParameter" in that it does not put a value into this objects parm table.


ensureLogon

    protected boolean ensureLogon()

This method will perfrom an automatic redirect to the logon page of the logon token is null. NOTE: Do not call this method during the "onCreate" event, since calling unstack during a dialog creation should not happen. Instead use this method during the "onDocumentChanged" event, which seem to always be called directly after the "onCreate" event. Returns true if logon token found, otherwise the logon xmldlg is stacked and false is returned. The current XMLDlg name and document will be passed to the logon for redirection following authentication.


getDataObject

    protected ENOVIDataObject getDataObject(ENOVTypeMask iMask)

Returns the data object for the given uuid


getDataObject

    protected ENOVIDataObject getDataObject(String iUUID)


getDataObject

    protected ENOVIDataObject getDataObject(String iUUID, ENOVTypeMask iMask)


getEnvValue

    protected String getEnvValue(String iKey, String iDfltValue)


getLogonToken

    protected ENOVILogonToken getLogonToken()


getObjectUUID

    protected String getObjectUUID()

Function to encapsulate accessing the UUID of the focal object. This function is useful for dialog focusing on a single object.


getParameter

    protected Object getParameter(String iName)

Returns a parameter value parsed from the input document value.


getParameter

    protected Object getParameter(String iName, String iDefault)

Returns a parameter value parsed from the input document value.


getStringValue

    protected String getStringValue(String iKey, String iDfltValue)

Returns the translated string or the key if no translation is found

Parameters:
iKey
CATNls file key, the CATNls file is determined by current dialog
iDfltValue
value returned if the key lookup fails
Return:
the translated string or the key if no translation is found

getStringValue

    protected String getStringValue(String iFile, String iKey, String iDfltValue)

Returns the translated string or the key if no translation is found

Parameters:
iFile
Name of the CATNls file
iKey
CATNls file key
iDfltValue
value returned if the key lookup fails
Return:
the translated string or the key if no translation is found

getWidgetID

    public String getWidgetID()

See Also:
com.dassault_systemes.PPRNBregistry.dialog.interfaces.PPRWidgetDialogIF#getWidgetID()

init

    protected void init(CATDialog iDialog, CATNotification iNotification, Object iData)

Initializes the basic constructor values.


onCancel

    public void onCancel(CATDialog iDialog, CATNotification iNotification, Object iData)


onCreate

    public void onCreate(CATDialog iDialog, CATNotification iNotification, Object iData)

onCreate event handler which calls "init".


onDocumentChanged

    public void onDocumentChanged(CATDialog iDialog, CATNotification iNotification, Object iData)

onDocumentChanged event handler which calls init or reintOnDocChg as appropriate.
NOTE: The onDocumentChanged event is only fired on the top level widget on a panel. If the controller is associated with a lower level widget in the panel, it cannot receive this event.


parseDocument

    protected void parseDocument()


processMessageForCATMessageArea

    protected void processMessageForCATMessageArea(String statusMsgText, CATSession session, boolean ok)


pushErrorMessage

    protected void pushErrorMessage(String iMsgKey)


pushMessage

    protected void pushMessage(String iMsgKey, int iSeverity)


reinitOnDocChg

    protected void reinitOnDocChg()

ReInitializes the list of parameters passed to this dialog as the document value.


setEnvValue

    protected void setEnvValue(String iKey, String iValue)


setParameters

    public void setParameters(Hashtable iParms)


showStatusMessage

    protected void showStatusMessage(Message iStatusMsg)

Displays the given status message with the current message stack for details.
  • Calls LCAJDialogUtils.showStatusMessage, passing _dialog.


    showStatusMessage

        protected void showStatusMessage(String iMsgKey, boolean iOk)
    
    
    Displays the given status message.
  • The current message stack is captured for details. The status message is obtained by using current dialog and the message given key. The message catalog name is obtained from the method "LCAJDialogUtils.getXMLDlgName".
  • Calls LCAJDialogUtils.showStatusMessage, passing _dialog.


    showStatusMessage

        protected void showStatusMessage(String iMsgFile, String iMsgKey, boolean iOk)
    
    
    Displays the given status message with the current message stack for details.
  • The current message stack is captured for details. The status message is obtained from the given CATNls file name (no extension) and message key.
  • Calls LCAJDialogUtils.showStatusMessage, passing _dialog.


    stack

        protected void stack(String iCommand)
    
    
    Calls another dialog, passing along all of the document parameters passed to this dialog.


    stack

        protected void stack(String iCommand, String iDocument)
    
    
    Calls another dialog, passing the input document parameters.


    stackReplace

        protected void stackReplace(String iCommand)
    
    
    Calls another dialog, passing along all of the document parameters passed to this dialog.


    stackView

        protected CATDialog stackView(String iCommand, String iDocument)
    
    
    Calls another dialog, passing the input document parameters.


    unstack

        protected void unstack()
    
    
    Removes this dialog from the stack. The previous dialog is made current.



    Copyright © 2000, Dassault Systèmes. All rights reserved