done (when a report page is returned)error (when an error code is returned)prompt (when an prompt page is returned)wait (when we get a ?working? and ?stillWorking? state)false.
@type bool
*/
CCognosViewer.prototype.canDrillDown = function(sId)
{
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
return (selectionController.canDrillDown(sCtx));
}
}
return false;
};
/**
Determines if the element supports drill up or not.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Default is false.
@type bool
*/
CCognosViewer.prototype.canDrillUp = function(sId)
{
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
return (selectionController.canDrillUp(sCtx));
}
}
return false;
};
/**
Call this function to know if all required prompts have valid inputs.
*/
CCognosViewer.prototype.canSubmitPrompt = function()
{
var oPromptElement = null;
if (this.preProcessControlArray && this.preProcessControlArray instanceof Array)
{
var kCount = this.preProcessControlArray.length;
for ( var k=0; k < kCount; k++ )
{
oPromptElement = eval( this.preProcessControlArray[k] );
if ( oPromptElement.isValid() === false )
{
return false;
}
}
}
return true;
};
/**
Context Menu Handler in Report Viewer.
dcm == Display Context Menu
@private
*/
CCognosViewer.prototype.dcm = function(event, selectNode)
{
if (this.canDisplayContextMenu())
{
if (this.rvMainWnd.displayContextMenu(event, selectNode) != false)
{
if(this.sBrowser=='ie')
{
event.cancelBubble = true;
event.returnValue = false;
}
else
{
event.stopPropagation();
event.preventDefault();
}
}
}
};
/**
* Determines if the viewer should show a context menu
* @private
*/
CCognosViewer.prototype.canDisplayContextMenu = function()
{
return (this.getStatus() != "prompting" && this.getStatus() != "working" && this.rvMainWnd != null && typeof this.bCanUseCognosViewerContextMenu != 'undefined' && this.bCanUseCognosViewerContextMenu);
};
/**
Handler for drill actions in Report Viewer.
de == Drill Event
@private
*/
CCognosViewer.prototype.de = function(event)
{
var oDrillMgr = this.getDrillMgr();
if (oDrillMgr)
{
oDrillMgr.singleClickDrillEvent(event, 'RV');
}
};
/**
@param {string} Message
@private
*/
CCognosViewer.prototype.debug = function(sMsg)
{
if (this.m_bDebug)
{
var sCallee = "";
var oCaller = this.debug.caller;
if (typeof oCaller == "object" && oCaller !== null)
{
sCallee = oCaller.toString().match(/function (\w*)/)[1];
}
if (!sCallee)
{
sCallee = '?';
}
alert(sCallee + ": " + sMsg);
}
};
/**
@param {string} sEvent Event name to call the callback functions for.
@type boolean
@return true if there was a callback associated with the event and that it's capture event was set to true. false otherwise.
@private
*/
CCognosViewer.prototype.executeCallback = function(sEvent)
{
var bEventWasCaptured = false;
if (this.m_aCallback && this.m_aCallback.length)
{
for (var idxCallback = 0; idxCallback < this.m_aCallback.length; ++idxCallback)
{
var oCB = this.m_aCallback[idxCallback];
if (oCB.m_sEvent == sEvent)
{
if (typeof oCB.m_oCallback == "function")
{
oCB.m_oCallback();
}
if (oCB.m_bCaptureEvent)
{
bEventWasCaptured = true;
}
}
}
}
return bEventWasCaptured;
};
/**
CAF context information.
@return CAF encoded string.
@type string
*/
CCognosViewer.prototype.getCAFContext = function()
{
return this.m_sCAFContext;
};
/**
Get the fault
@return string
*/
CCognosViewer.prototype.getSoapFault = function()
{
return this.m_sSoapFault;
}
/**
Returns the identifiers of the columns related to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return array of identifiers of the columns making up this element.
@type string[]
*/
CCognosViewer.prototype.getColumnContextIds = function(sId)
{
return this.getContextIds(sId, 2);
};
/**
Conversation info (encoded string).
@return CAF encoded string.
@type string
*/
CCognosViewer.prototype.getConversation = function()
{
return this.m_sConversation;
};
/**
* Status of the ongoing report server conversation
* @return conversation status
* @type string
*/
CCognosViewer.prototype.getStatus = function()
{
return this.m_sStatus;
};
/**
* Returns the action state. This value will only be set if the action is in a interupted state (wait/prompting)
* @return action state
* @type string
*/
CCognosViewer.prototype.getActionState = function()
{
return this.m_sActionState;
};
/**
Get the name of the ref data item associated with the element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Name of the ref data item associated with the element. Returns null if there is not any.
@type string
*/
CCognosViewer.prototype.getDataItemName = function(sId)
{
var sName = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aName = selectionController.getRefDataItem(sCtx);
if (aName) {
sName = aName;
}
}
}
return sName;
};
/**
Get the Name of the data type associated with the element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Name of the data type associated with the element. Returns null if there is not any.
@type int
*/
CCognosViewer.prototype.getDataType = function(sId)
{
var sType = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aType = selectionController.getDataType(sCtx);
if (aType) {
sType = aType;
}
}
}
return sType;
};
/**
Returns the level associated with the element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Depth (relative to the hierarchy) of the element. Returns null if there is not any.
@type integer
*/
CCognosViewer.prototype.getDepth = function(sId)
{
var sLevel = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aLevel = selectionController.getDepth(sCtx);
if (aLevel) {
sLevel = aLevel;
}
}
}
return sLevel;
};
/**
@return CAF encoded string.
@type string
@private
*/
CCognosViewer.prototype.getDrillMgr = function()
{
return this.m_oDrillMgr;
};
/**
@return the subscription handler.
@type object
@private
*/
CCognosViewer.prototype.getSubscriptionManager = function()
{
return this.m_oSubscriptionManager;
};
/**
Execution Parameters (encoded string).
@return CAF encoded string.
@type string
*/
CCognosViewer.prototype.getExecutionParameters = function()
{
return this.m_sParameters;
};
/**
@private
@return Gateway path.
@type string
*/
CCognosViewer.prototype.getGateway = function()
{
return this.m_sGateway;
};
/**
Returns the Hierarchy Unique Name (HUN) associated to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Name (HUN) of the hierarchy associated with the element. Returns null if there is not any.
@type string
*/
CCognosViewer.prototype.getHierarchyUniqueName = function(sId)
{
var sHun = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aHUN = selectionController.getHun(sCtx);
if (aHUN) {
sHun = aHUN;
}
}
}
return sHun;
};
/**
Returns the Dimension Unique Name (DUN) associated to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Name (DUN) of the dimension associated with the element. Returns null if there is not any.
@type string
*/
CCognosViewer.prototype.getDimensionUniqueName = function(sId)
{
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aDUN = selectionController.getDun(sCtx);
if (aDUN) {
return aDUN;
}
}
}
return null;
};
/**
@private
@return Id Identifier for this instance of CCognosViewer.
@type string
*/
CCognosViewer.prototype.getId = function()
{
return this.m_sId;
};
/**
Returns the Level Id (LUN) associated to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Identifier for the level associated with the element. Returns null if there is not any.
@type string
*/
CCognosViewer.prototype.getLevelId = function(sId)
{
var sLevel = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aLUN = selectionController.getLun(sCtx);
if (aLUN) {
sLevel = aLUN;
}
}
}
return sLevel;
};
/**
Returns the Member Unique Name (MUN) associated to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Name (MUN) of the member associated with the element. Returns null if there is not any.
@type string
*/
CCognosViewer.prototype.getMemberUniqueName = function(sId)
{
var sMUN = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aMUN = selectionController.getMun(sCtx);
if (aMUN) {
sMUN = aMUN;
}
}
}
return sMUN;
};
/**
This function return the name of the javascript reference (variable) to this object. The default is "window" if the id is invalid.
@private
@return Id Identifier for this instance of CCognosViewer.
@type string
*/
CCognosViewer.prototype.getObjectId = function()
{
var sObjId = "window";
if (typeof this.getId() == "string") {
sObjId = "oCV" + this.getId();
}
return sObjId;
};
/**
Returns the Query Id associated to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Model id associated with the element. Returns null if there is not any.
@type string
*/
CCognosViewer.prototype.getQueryModelId = function(sId)
{
var sQuery = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aQMID = selectionController.getQueryModelId(sCtx);
if (aQMID) {
sQuery = aQMID;
}
}
}
return sQuery;
};
/**
Returns the Query name associated to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Query name associated with the element. Returns null if there is not any.
@type string
*/
CCognosViewer.prototype.getQueryName = function(sId)
{
var sQuery = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
var aQuery = selectionController.getRefQuery(sCtx);
if (aQuery) {
sQuery = aQuery;
}
}
}
return sQuery;
};
CCognosViewer.prototype.getContextIds = function(sId, index)
{
var aIds = [];
var sCtx = this.findCtx(sId);
if (sCtx)
{
var aIDparts = sCtx.split("::");
if (aIDparts && aIDparts.length > 1 && index < aIDparts.length)
{
aIds = aIDparts[index].split(":");
}
}
return aIds;
};
/**
Returns the identifiers of the rows related to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return array of identifiers of the rows making up this element.
@type string[]
*/
CCognosViewer.prototype.getRowContextIds = function(sId)
{
return this.getContextIds(sId, 1);
};
/**
Returns the identifiers of the page related to an element.
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return array of identifiers of the rows making up this element.
@type string[]
*/
CCognosViewer.prototype.getPageContextIds = function(sId)
{
return this.getContextIds(sId, 3);
};
/**
@private
@param {string} sKey the key of the string
@type string
@return The localized string matching the key. Returns the key if it there is not string associated.
*/
CCognosViewer.prototype.getString = function(sKey)
{
if (this.oStrings && this.oStrings[sKey]) {
return this.oStrings[sKey];
}
return sKey;
};
/**
@private
@type CViewerManager
@return A CViewerManager instance or a "window" object if the former do not exists.
*/
CCognosViewer.prototype.getRV = function()
{
if (typeof this.m_oCVMgr == "object")
{
return this.m_oCVMgr;
}
return window;
};
/**
@private
@type array
@return available secondary requests
*/
CCognosViewer.prototype.getSecondaryRequests = function()
{
return this.m_aSecRequests;
};
/**
@private
@type string
@return session prompts (CAF string)
*/
CCognosViewer.prototype.getSessionPrompts = function()
{
return this.m_sSessionPrompts;
};
/**
Tracking info (encoded string).
@type string
@return CAF encoded string.
*/
CCognosViewer.prototype.getTracking = function()
{
return this.m_sTracking;
};
/**
@private
@type string
@param {string} sId Identifier or a HTML element
@return Returns an empty string if not found.
*/
CCognosViewer.prototype.findCtx = function(sId)
{
var sCtx = "";
if (typeof sId == "string")
{
// return sId if it matches something in the context data
var sRefDataItem = sId.split("::")[0];
var selectionController = this.getSelectionController();
if (selectionController != null) {
if (selectionController.isContextId(sRefDataItem))
{
sCtx = sId;
}
}
}
if (!sCtx)
{
var oHTMLElement = this.findElementWithCtx(sId);
if (oHTMLElement)
{
sCtx = oHTMLElement.getAttribute("ctx");
}
}
return sCtx;
};
/**
@private
@type HTMLelement
@param {string} sId Identifier or a HTML element
@return Returns a HTML element with a ctx attribute. Processed recursively on the children. Returns null if there is not any.
*/
CCognosViewer.prototype.findElementWithCtx = function(sId)
{
var oElement = sId;
if (typeof sId == "string") {
oElement = this.findElementWithCtx(document.getElementById(sId));
}
if (oElement)
{
if (oElement.getAttribute && oElement.getAttribute("ctx"))
{
return oElement;
}
for (var idxChild = 0; idxChild < oElement.childNodes.length; idxChild++)
{
var oChild = this.findElementWithCtx(oElement.childNodes[idxChild]);
if (oChild) {
return oChild;
}
}
}
return null;
};
/**
Returns the use value associated to an element.
@type string
@param {string} sId Identifier or the HTML element with a ctxId attribute.
@return Use value associated with the element. Returns null if there is not any.
*/
CCognosViewer.prototype.getUseValue = function(sId)
{
var sVal = null;
var sCtx = this.findCtx(sId).split("::")[0];
if (sCtx) {
var selectionController = this.getSelectionController();
if (selectionController != null) {
sVal = selectionController.getUseValue(sCtx);
}
}
return sVal;
};
/**
@private
@param {object} oProp Properties to add to this instance of CCognosViewer, like flags and strings.
*/
CCognosViewer.prototype.init = function(oProperties)
{
if (oProperties && typeof oProperties == "object")
{
for (var sProp in oProperties)
{
this[sProp] = oProperties[sProp];
}
}
};
/**
* @private
* Method that should only be called when the user hits the back button in the browser
*/
CCognosViewer.prototype.initStandaloneViewerState = function(originalState)
{
var backJaxForm = document.getElementById('formBackJax' + this.getId());
if (typeof backJaxForm != "undefined" && backJaxForm != null && typeof backJaxForm.responseText != "undefined" && backJaxForm.responseText.value.length > 0)
{
this.processResponseText(backJaxForm.responseText.value);
}
else
{
this.processResponseState(originalState);
}
};
/**
* @private
* @Saves the responseXML for a completed request
*/
CCognosViewer.prototype.saveBackJaxInformation = function(responseText)
{
var backJaxForm = document.getElementById('formBackJax' + this.getId());
if (typeof backJaxForm != "undefined" && backJaxForm != null)
{
if (typeof backJaxForm.responseText != "undefined")
{
backJaxForm.responseText.value = responseText;
}
}
};
/**
Pre-selects a node prior handling of the context menu.
pcc == Page Context Clicked
@private
*/
CCognosViewer.prototype.pcc = function(evt)
{
var selectionController;
try
{
selectionController = eval("oCVSC" + this.getId());
}
catch(e)
{
selectionController = null;
}
if(selectionController != null)
{
selectionController.pageContextClicked(evt);
}
};
/**
* @private
* @param {XMLHTTP response} oResponse
*/
CCognosViewer.prototype.isValidAjaxResponse = function(responseXML)
{
return (responseXML != null && responseXML.childNodes.length != 0 && responseXML.childNodes[0].nodeName != "parsererror");
};
/**
* @private
*/
CCognosViewer.prototype.resubmitInSafeMode = function()
{
//re-submit the request in "page" mode. We'll need to inform the user we're doing this (Post beta)
this.setUsePageRequest(true);
this.envParams["cv.useAjax"] = "false";
this.m_oServerRequest.clearRequest();
this.sendRequest(this["LAST_ACTION_PARAMS"].param1);
};
/**
@private
@param {XMLHTTP response} oResponse
*/
CCognosViewer.prototype.processResponse = function(oResponse)
{
var oResponseState = null;
try
{
var sContentType = oResponse.getResponseHeader("Content-type");
if(sContentType.indexOf("text/html") != -1)
{
// make sure we clear the tracking and conversation before we unload the viewer
// or we'll trigger a cancel request which will more then likely cause another fault.
this.m_sTracking = "";
this.m_sConversation = "";
clearLastAction();
// this is an HTML response, most likely a fault page.
document.write(oResponse.responseText);
}
// application/xml should only be used for data only response (i.e. no HTML)
else if (sContentType.indexOf("application/xml") != -1)
{
var responseXML = oResponse.responseXML;
if(this.isValidAjaxResponse(responseXML) == false)
{
// try re-parsing client side
responseXML = XMLBuilderLoadXMLFromString(oResponse.responseText);
}
this.processResponseXML(responseXML, null);
}
else
{
var responseText = oResponse.responseText;
if (responseText == null)
{
this.resubmitInSafeMode();
}
this.processResponseText(responseText);
}
}
catch (e)
{
oResponseState = null;
this.executeCallback("error");
}
}
/**
@private
@param {XMLHTTP response} sText
@param {Boundary from the header} sText
*/
CCognosViewer.prototype.processResponseText = function (sText)
{
var boundaryIndex = sText.indexOf("");
if (boundaryIndex == -1)
{
this.resubmitInSafeMode();
}
// length of ""
boundaryIndex += 14;
var xmlPart = sText.substring(0, boundaryIndex);
var responseXML = XMLBuilderLoadXMLFromString(xmlPart);
var resposneHTML = sText.substring(boundaryIndex);
if (this.processResponseXML(responseXML, resposneHTML))
{
if (this.getStatus() != "working" && this.getStatus() != "stillWorking")
{
clearLastAction();
}
this.saveBackJaxInformation(sText);
}
}
/**
@private
@param XML element
@param responseHTML
*/
CCognosViewer.prototype.processResponseXML = function (responseXML, responseHTML)
{
if(this.isValidAjaxResponse(responseXML) == false)
{
this.resubmitInSafeMode();
return false;
}
else if (processAuthenticationFault(responseXML))
{
return false;
}
else
{
try
{
var stateData = responseXML.getElementsByTagName("state");
if (stateData != null && stateData.length > 0)
{
if (typeof stateData[0].text != "undefined")
{
oResponseState = eval("(" + stateData[0].text + ")");
}
else
{
oResponseState = eval("(" + stateData[0].textContent + ")");
}
}
if (oResponseState)
{
var sStatus = oResponseState.status;
var bWaitPage = sStatus == "working" || sStatus == "stillWorking";
if (!bWaitPage && this.sBrowser == 'moz')
{
var oRVContent = document.getElementById('RVContent' + this.getId());
if (oRVContent)
{
if (typeof oResponseState.outputFormat != 'undefined' && oResponseState.outputFormat == 'XML')
{
oRVContent.style.overflow = 'hidden';
}
else
{
oRVContent.style.overflow = 'auto';
}
}
}
if (typeof responseHTML == "string")
{
var oRVContent = document.getElementById('RVContent' + this.getId());
if (!bWaitPage && oRVContent)
{
oRVContent.scrollTop=0;
}
if (bWaitPage)
{
this.m_waitPage.initializeWaitPage(responseHTML);
}
else if(this.processResponseOutput(responseHTML) === false)
{
return;
}
}
this.gbPromptRequestSubmitted = false;
this.processResponseState(oResponseState);
}
}
catch (e)
{
oResponseState = null;
this.executeCallback("error");
return false;
}
}
return true;
};
/**
@private
@param {string} sResponseText
@return (boolean)
*/
CCognosViewer.prototype.processResponseOutput = function(sResponseText)
{
try
{
if(this.m_undoStack.length > 0)
{
this.m_undoStack[this.m_undoStack.length-1].m_bRefreshPage = true;
}
this.pageNavigationObserverArray = [];
// IE bug: innerHTML do not handle