///////////////////////////////////////////////////////////////////////////
// Scripting Tutorial #10 - Matrix with Enhanced Dialog
///////////////////////////////////////////////////////////////////////////
//  
// Title 
//   Report to list all attributes from the current selected object(s)
//   in a Matrix
// 
// Main new features
//   - Two more Dialog Options
//   - Dynamic Dialog Entries
//   - Hidden Attributes
//   - Dynamic Dialog Overflow
// 
// 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
// ShowDefaultAttributes (creation date, creator..)
var bShowDefaultAttributes = true
// Highlight changed values with red
var bHighlightChangedValues = true
// List of standard Attributes (creation date, creator..)
var nDefaultAttributesList = [Constants.AT_CREATOR,Constants.AT_LAST_CHNG_2,Constants.AT_LUSER,Constants.AT_CREAT_TIME_STMP,Constants.AT_TYPE_6]
// List of Object types to show in the dialog
var sObjectTypeList = new Array()
 
/** Main Function
*/
function main(){

    //
    //
    //
    // NEW IN PART #10
    // Entire code has been moved into shared library
    //
    //
    // if no object occurrence selected, try model and objects itself
    var oObjOccList = checkSelectedObjOccs();
    
    // if at least one object selected
    if (oObjOccList.length > 0) {
        
        // Create a list of Object Types
        var oObjTypeList = new Array();
        for (o=0;o<oObjOccList.length;o++)
	        oObjTypeList.push(oObjOccList[o].ObjDef().Type());
        
        // Make this list unique
        oObjTypeList=ArisData.Unique(oObjTypeList);   
        
        // Open the Dialog and show the found object types
        if (userDlg(oObjTypeList))  {
            
            // Object occurrence list
            var oObjOccListNew = new Array()
            // Based on the response we will now reduce the objects again
            for (o=0;o<oObjOccList.length;o++) {
                var type=oObjOccList[o].ObjDef().Type()
                if ( contains(sObjectTypeList,type)) {
                    oObjOccListNew.push(oObjOccList[o])
                }
            }
            
            // reassign changed list
            oObjOccList = oObjOccListNew    
    
            // Manage Output file name
            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))    
        
            // 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) {
                        if (bShowDefaultAttributes)
                            oObjAttrList.push(attrlist[p].TypeNum());
                        else {
                            if (nDefaultAttributesList.indexOf(attrlist[p].TypeNum())<0) {
                                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
            for (i=0;i<oObjAttrList.length;i++) {
                oOutput.TableRow();
                oOutput.TableCellF(currFilter.AttrTypeName(oObjAttrList[i]), 15, "TABLE_HEAD_LEFT");
                var vOldValue="!&!"
                for (j=0;j<oObjDefList.length;j++) {
                    var oAttr=oObjDefList[j].Attribute(oObjAttrList[i], nLocale)
                    if (oAttr != null) {
                        if (vOldValue.equals(oAttr.getValue()) || vOldValue.equals("!&!"))
                            oOutput.TableCellF(oAttr.getValue(), 15, "TABLE_DATA");
                        else {
                           if (bHighlightChangedValues)
                             oOutput.TableCellF(oAttr.getValue(), 15, "TABLE_DATA_RED"); 
                           else
                             oOutput.TableCellF(oAttr.getValue(), 15, "TABLE_DATA");   
                        }
                        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);
            oOutput.WriteReport();
        }  

    } 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(oObjTypeList)
{
    // validate, if this dialog is allowed to be called (not in BP)
    if (sEnv == "BP")
        return true;
    
    var nuserdlg = 1;   // initialize nuserdlg
    var binput = false; // initialize binput
    
    while (binput == false && ! (nuserdlg == 0)) {
  
        var nObjTypeListLength = oObjTypeList.length
        // Variable for the user dialog definition
        var userdialog = Dialogs.createNewDialogTemplate(0, 0, 500, 250, sScriptName);
    
        // define the layout
        userdialog.Text(50, 15, 400, 15, getString("DLG_MAIN_MESSAGE"));
        userdialog.GroupBox(40,40, 450, 60,getString("DLG_HINT_GENERAL_OPTIONS"))
            userdialog.CheckBox(70,60, 200, 15, getString("DLG_SHOW_DEFAULT_ATTRIBUTES"), "DLG_SHOW_DEFAULT_ATTRIBUTES");
            userdialog.CheckBox(70,75, 200, 15, getString("DLG_USE_FIXED_OUTPUT_FILENAME"), "DLG_USE_FIXED_OUTPUT_FILENAME");
            userdialog.CheckBox(280,60, 200, 15, getString("DLG_HIGHLIGHT_CHANGED_VALUES"), "DLG_HIGHLIGHT_CHANGED_VALUES");
        userdialog.GroupBox(40,105, 450, 40,getString("DLG_HINT_OUTPUT_FONT_SIZE"))
            userdialog.ComboBox(70,120, 150, 15, aOutputFontSizeList, "DLG_OUTPUT_FONT_SIZE");
      
        // Dynamic Dialog Section
        // Dynamic Group - in Max 3 Rows High
        userdialog.GroupBox(40,150, 450, 30+Math.min(nObjTypeListLength,4)*15,
            getString("DLG_HINT_OBJECT_TYPES_TO_DISPLAY"))
    
        // Dynamic CheckBoxes: Overflow after 4 elements in a column
        var xpos=70
        var ypos=170
        for (c=0;c<nObjTypeListLength;c++) {
            if (c==4) {xpos=280; ypos=110;}
            userdialog.CheckBox(xpos,ypos+c*15, 200, 15, oObjTypeList[c], 
                "DLG_"+oObjTypeList[c].toUpperCase());
        }    
      
        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_29d0eb40-663d-11df-123a-005056c00008";  
        ReadSettingsDlgValue(dlg, sSection, "DLG_SHOW_DEFAULT_ATTRIBUTES", 0);
        ReadSettingsDlgValue(dlg, sSection, "DLG_USE_FIXED_OUTPUT_FILENAME", 0);
        ReadSettingsDlgValue(dlg, sSection, "DLG_HIGHLIGHT_CHANGED_VALUES", 0);
        ReadSettingsDlgValue(dlg, sSection, "DLG_OUTPUT_FONT_SIZE", 0);
        for (c=0;c<nObjTypeListLength;c++)
            ReadSettingsDlgValue(dlg, sSection, "DLG_"+oObjTypeList[c].toUpperCase(), 0);
    
        // Show dialog (wait for ok or cancel).
        nuserdlg = Dialogs.show(dlg);
        if (nuserdlg != 0) {
            // read the values from the dialog
            bShowDefaultAttributes = (dlg.getDlgValue("DLG_SHOW_DEFAULT_ATTRIBUTES") == 1);
            bUseFixedOutPutFileName = (dlg.getDlgValue("DLG_USE_FIXED_OUTPUT_FILENAME") == 1);
            bHighlightChangedValues = (dlg.getDlgValue("DLG_HIGHLIGHT_CHANGED_VALUES") == 1);
            nOutputFontSizeOffset = dlg.getDlgValue("DLG_OUTPUT_FONT_SIZE");
    
            for (c=0;c<nObjTypeListLength;c++) {
                if (dlg.getDlgValue("DLG_"+oObjTypeList[c].toUpperCase()) == 1)   {
                    sObjectTypeList.push(oObjTypeList[c]) 
                }
            }
            
            // Validate if at least one object type is selected
            if (sObjectTypeList.length<1) {
                Dialogs.MsgBox(getString("DLG_AT_LEAST_ONE_OBJECT_TYPE"), 
                   Constants.MSGBOX_BTN_OK + Constants.MSGBOX_ICON_WARNING, sScriptName);
                binput = false;
            } else {
                binput = true;
            } 
    
            // Write dialog settings to config      
            WriteSettingsDlgValue(dlg, sSection, "DLG_SHOW_DEFAULT_ATTRIBUTES");
            WriteSettingsDlgValue(dlg, sSection, "DLG_USE_FIXED_OUTPUT_FILENAME");
            WriteSettingsDlgValue(dlg, sSection, "DLG_HIGHLIGHT_CHANGED_VALUES");
            WriteSettingsDlgValue(dlg, sSection, "DLG_OUTPUT_FONT_SIZE");
            for (c=0;c<nObjTypeListLength;c++)
                WriteSettingsDlgValue(dlg, sSection, "DLG_"+oObjTypeList[c].toUpperCase(), 0);
        }
    }
    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);
}

/** Simple function to validate value existence in array
 * @param {Array} array The input array
 * @param {String} value The value to look for
*/
function contains(array, value) {
    for (i=0;i<array.length;i++){
        if (array[i].match(value)) return true;
    }
    return false;
}    

// call the main function
main()