///////////////////////////////////////////////////////////////////////////
// Scripting Tutorial #9 - Matrix
///////////////////////////////////////////////////////////////////////////
// Title 
//   Report to list all attributes from the current selected object(s)
//   in a Matrix
// 
// Main Features
//   - Matrix Report with Attributes in the row and Objects in the columns
//   - Dynamic and Unique Liste of Attributes
//   - Dynamic List of Objects
//   - Model Name only when changed
//   - Colored changes
//   - Function AttrList to get maintained attributes
// 
// Author
//   Volker Eckardt, Oracle Corporation, April 2010
///////////////////////////////////////////////////////////////////////////

// global variables for reuse
var nLocale=Context.getSelectedLanguage();
var sScriptName=Context.getScriptInfo(Constants.SCRIPT_NAME);
// Environment, returns STD or BP 
var sEnv = Context.getEnvironment() 
// To force a fixed Excel file name, set to true
var bUseFixedOutPutFileName = true
// Font Size List
var aOutputFontSizeList = [getString("ID_FONT_SIZE_SMALL"), getString("ID_FONT_SIZE_MEDIUM"), getString("ID_FONT_SIZE_LARGE")]
var nOutputFontSizeOffset = 1
// Show Dialog
var bShowDialog = false

 
/** Main Function
*/
function main(){

    // React on Parameter 1
    if (bUseFixedOutPutFileName) 
        // if requested, assign a fixed file name 
      var oOutput=Context.createOutputObject(Context.getSelectedFormat(),getFixedFileName());
    else
        // Create an output Object
      var oOutput=Context.createOutputObject();

    // define page and write Header + Footer
    writeHeaderAndFooter(oOutput)
    
    // define the styles 
    defineStyles(oOutput);
    // set the html page title
    oOutput.SetTitle(Context.getScriptInfo(Constants.SCRIPT_NAME))    
    
    // Validate, if standard execution is requested (not BP)
    if (sEnv == "STD") {
        // read the current selected object occurrences
        var oObjOccList = ArisData.getSelectedObjOccs();
    } else {
        // set to an empty array by now
        var oObjOccList = new ObjOcc  // also possible: var objoccs = [] 
    }    
    
    // if no object occurrence is selected, try also objectdef
    if (oObjOccList.length == 0) {
       var objDefs = ArisData.getSelectedObjDefs ();
       // is at least one object is selected
       // hint: you can select multiple objects in the search result window
       if (objDefs.length > 0)
           // collect referenced object occurrences
           oObjOccList = collectObjOccs(objDefs)
       else {
           // if no objOcc and no objDef is selected, try model
           var modDefs = ArisData.getSelectedModels()
           // is a model selected? Take the first only.
           if ( modDefs.length > 0 )
             oObjOccList = modDefs[0].ObjOccListFilter()
       }
    }
    
    // if at least one object selected
    if (oObjOccList.length > 0) {

        // Write joined Header Line (Script Name), not supported in pdf
        oOutput.BeginTable(100, Constants.C_BLACK, Constants.C_WHITE,  Constants.FMT_LEFT | Constants.FMT_REPEAT_HEADER, 0)
        oOutput.TableRow();
        if(Context.getSelectedFormat()==Constants.OUTPDF)
            oOutput.TableCellF( Context.getScriptInfo(Constants.SCRIPT_NAME), 100, "TITLE")
        else
            oOutput.TableCell ( Context.getScriptInfo(Constants.SCRIPT_NAME), 1, oObjOccList.length+1, getString("ID_DEFAULT_FONT"), 12, Constants.C_OLIVE, Constants.C_WHITE,  0,Constants.FMT_BOLD  | Constants.FMT_CENTER | Constants.FMT_VCENTER,0)
        
        var currFilter = ArisData.ActiveFilter();
        
        // Construct Array #1: Column Header
        // Create a list of Object Defs
        var oObjDefList = new Array();
        for (o=0;o<oObjOccList.length;o++)
		    oObjDefList.push(oObjOccList[o].ObjDef());
        
        // Construct Array #2: Row Header
        // Create a list of used Attributes for all Objects
        var oObjAttrList = new Array();
        for (o=0;o<oObjOccList.length;o++) {
            var attrlist=oObjOccList[o].ObjDef().AttrList(nLocale);
            for (p=0;p<attrlist.length;p++) {
		       if (attrlist[p].TypeNum()!=Constants.AT_NAME) 
                   oObjAttrList.push(attrlist[p].TypeNum());
            }
        }    
        
        // Make this list unique
        oObjAttrList=ArisData.Unique(oObjAttrList);    
       
        // Header Line 1: Write Object Model
        oOutput.TableRow();
        oOutput.TableCellF(getString("ID_META_MODEL_NAME"), 15, "TABLE_DATA_RIGHT");
        var sOldModelName = ""
        for (i=0;i<oObjOccList.length;i++){
            var sModelName = oObjOccList[i].Model().Name(nLocale)
            if (sOldModelName != sModelName) 
                oOutput.TableCellF(sModelName, 15, "TABLE_HEAD");
            else
                oOutput.TableCellF("", 15, "TABLE_DATA");
            sOldModelName = sModelName
        }

        // Header Line 2: Write Object Name
        oOutput.TableRow();
        oOutput.TableCellF(getString("ID_META_OBJECT_NAME"), 15, "TABLE_DATA_RIGHT");
        for (i=0;i<oObjDefList.length;i++)
            oOutput.TableCellF(oObjDefList[i].Name(nLocale), 15, "TABLE_HEAD");
        
        // Header Line 3: Write Object Type
        oOutput.TableRow();
        oOutput.TableCellF(getString("ID_META_OBJECT_TYPE"), 15, "TABLE_DATA_RIGHT");
        for (i=0;i<oObjDefList.length;i++)
            oOutput.TableCellF(oObjDefList[i].Type(), 15, "TABLE_HEAD");

        // Attribute Lines
        // Loop through all Attributes
        for (i=0;i<oObjAttrList.length;i++) {
            oOutput.TableRow();
            oOutput.TableCellF(currFilter.AttrTypeName(oObjAttrList[i]), 15, "TABLE_HEAD_LEFT");
            
            // Loop through all objects
            var vOldValue="!&!"
            for (j=0;j<oObjDefList.length;j++) {
                var oAttr=oObjDefList[j].Attribute(oObjAttrList[i], nLocale)
                // if this attribute is mainatined for this object 
                if (oAttr != null) {
                    if (vOldValue.equals(oAttr.getValue()) || vOldValue.equals("!&!"))
                        oOutput.TableCellF(oAttr.getValue(), 15, "TABLE_DATA");
                    else
                        oOutput.TableCellF(oAttr.getValue(), 15, "TABLE_DATA_RED"); 
                    vOldValue = oAttr.getValue();
                }    
                else
                    oOutput.TableCellF("", 15, "TABLE_DATA");
            }    
        }
        // write subtable summary
        oOutput.TableRow();
        oOutput.TableCell(getString("ID_ATTR_TOTAL") + oObjAttrList.length, 1, oObjOccList.length+1, getString("ID_DEFAULT_FONT"), 10, Constants.C_BLACK, Constants.C_WHITE,  0,Constants.FMT_BOLD  | Constants.FMT_CENTER | Constants.FMT_VCENTER,0)
        oOutput.EndTable(sScriptName, 100, "", 0, Constants.C_BLACK, Constants.C_TRANSPARENT, 0, Constants.FMT_LEFT, 0);

    } else {
        // Write a hint in case a valid object is not selected
        oOutput.BeginTable(100, Constants.C_BLACK, Constants.C_WHITE,  Constants.FMT_LEFT | Constants.FMT_REPEAT_HEADER, 0)
        oOutput.TableRow();
        oOutput.TableCellF(getString("ID_HINT_VALID_OBJ_OCCS"), 100, "ERROR");
        oOutput.EndTable(getString("ID_HINT"), 100, "", 0, Constants.C_BLACK, Constants.C_TRANSPARENT, 0, Constants.FMT_LEFT, 0);
    }    
    
    oOutput.WriteReport();
} // End of main()


/** Renders and displays a dialog
*/
function userDlg()
{
    // validate, if this dialog is allowed to be called (not in BP)
    if (sEnv == "BP" || !bShowDialog)
      return true;
  
    // Variable for the user dialog definition
    var userdialog = Dialogs.createNewDialogTemplate(0, 0, 440, 100, sScriptName);

    // define the layout
    userdialog.Text(60, 40, 400, 15, getString("DLG_MAIN_MESSAGE"));
    userdialog.CheckBox(60,80, 300, 15, getString("DLG_USE_FIXED_OUTPUT_FILENAME"), "DLG_USE_FIXED_OUTPUT_FILENAME");
    userdialog.Text(60, 150, 400, 15, getString("DLG_HINT_OUTPUT_FONT_SIZE"));
    userdialog.ComboBox(60,170, 150, 15, aOutputFontSizeList, "DLG_OUTPUT_FONT_SIZE");
    userdialog.OKButton();
    userdialog.CancelButton();
    //  userdialog.HelpButton("HID_d15ec480_4286_11d9_74b9_000f1f28afc9_dlg_01.hlp");

    // Render the dialog
    var dlg = Dialogs.createUserDialog(userdialog); 

    // Read dialog settings from config (if any)
    var sSection = "DLG_VALUES_0e093560-5eaa-11df-123a-005056c00008";  
    ReadSettingsDlgValue(dlg, sSection, "DLG_USE_FIXED_OUTPUT_FILENAME", 0);
    ReadSettingsDlgValue(dlg, sSection, "DLG_OUTPUT_FONT_SIZE", 0);

    // Show dialog (wait for ok or cancel).
    var nuserdlg = Dialogs.show(dlg);
    if (nuserdlg != 0) {
        // read the values from the dialog
        bUseFixedOutPutFileName = (dlg.getDlgValue("DLG_USE_FIXED_OUTPUT_FILENAME") == 1);
        nOutputFontSizeOffset = dlg.getDlgValue("DLG_OUTPUT_FONT_SIZE");
    
        // Write dialog settings to config      
        WriteSettingsDlgValue(dlg, sSection, "DLG_USE_FIXED_OUTPUT_FILENAME");
        WriteSettingsDlgValue(dlg, sSection, "DLG_OUTPUT_FONT_SIZE");
    }
    return (nuserdlg != 0)
}
    
/** Defines a format template - style
 * @param {Output} oOutput The output object
*/
function defineStyles(oOutput) {
    oOutput.DefineF("TEXT", getString("ID_DEFAULT_FONT"), 8+nOutputFontSizeOffset, Constants.C_DARK_BLUE, Constants.C_TRANSPARENT, Constants.FMT_LEFT, 0, 0, 0, 0, 0, 0);
    oOutput.DefineF("TEXT_RIGHT", getString("ID_DEFAULT_FONT"), 8+nOutputFontSizeOffset, Constants.C_DARK_BLUE, Constants.C_TRANSPARENT, Constants.FMT_RIGHT, 0, 0, 0, 0, 0, 0);
    oOutput.DefineF("TABLE_HEAD",getString("ID_DEFAULT_FONT"), 9+nOutputFontSizeOffset, Constants.C_BLACK, Constants.C_SKY_BLUE, Constants.FMT_BOLD  | Constants.FMT_CENTER | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TABLE_HEAD_RIGHT",getString("ID_DEFAULT_FONT"), 9+nOutputFontSizeOffset, Constants.C_BLACK, Constants.C_SKY_BLUE, Constants.FMT_BOLD  | Constants.FMT_RIGHT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TABLE_HEAD_LEFT",getString("ID_DEFAULT_FONT"), 9+nOutputFontSizeOffset, Constants.C_BLACK, Constants.C_SKY_BLUE, Constants.FMT_BOLD  | Constants.FMT_LEFT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TABLE_DATA",getString("ID_DEFAULT_FONT"), 9+nOutputFontSizeOffset, Constants.C_BLACK, Constants.C_WHITE, Constants.FMT_LEFT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TABLE_DATA_RIGHT",getString("ID_DEFAULT_FONT"), 9+nOutputFontSizeOffset, Constants.C_BLACK, Constants.C_WHITE, Constants.FMT_RIGHT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TABLE_DATA_RED",getString("ID_DEFAULT_FONT"), 9+nOutputFontSizeOffset, Constants.C_RED, Constants.C_WHITE, Constants.FMT_LEFT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("ERROR",getString("ID_DEFAULT_FONT"), 11+nOutputFontSizeOffset, Constants.C_RED, Constants.C_WHITE, Constants.FMT_LEFT | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
    oOutput.DefineF("TITLE",getString("ID_DEFAULT_FONT"), 13+nOutputFontSizeOffset, Constants.C_OLIVE, Constants.C_WHITE, Constants.FMT_BOLD  | Constants.FMT_CENTER | Constants.FMT_VCENTER, 0, 0, 0, 0, 0, 1);
}

// call the main function
if (userDlg() == true) main()