Manual
Modules Loaded
Module scripting commands
General scripting commands
Scripting
Commands for other classes
MesquiteModule
showEmployeeTree
employers
Explanation:
Show employers of this module
executeShellScript
Explanation:
Executes a shell script
Parameters:
[path to script file]
dumpParameterTree
showManual
Explanation:
Shows manual in browser
showCommandPage
showMiniInfoWindow
openSourceInEclipse
setAssignedID
getWindow
getContainingWindow
saveMacro
applyMacro
showWindow
showWindowForce
repaintWindow
showFile
getFileCoordinator
getProject
getProjectID
getEmployee
getImmediateEmployee
hireEmployee
notifyParametersChanged
fireEmployee
resign
MesquiteWindow
showWindow
Explanation:
Makes the window visible
setAsFront
Explanation:
brings window to front
showWindowForce
Explanation:
Makes the window visible
forceRepaint
Explanation:
Forces repaint of window
popOut
Explanation:
Pops Window out of project window (if compacted)
popAsTile
Explanation:
Indicates whether to pop as tile or separate window
Parameters:
[true or false]
frame
Explanation:
Lists windows of frame
first
Explanation:
Flips to window of frame
next
Explanation:
Flips to window of frame
setActive
Explanation:
Sets this window to be foremost; to be used in scripting
closeWindow
Explanation:
Closes the window (calls owner module's windowGoAway)
showExplanations
Explanation:
Composes and shows the menu and control explanations web page
copy
Explanation:
Copies current selection to clipboard
cut
Explanation:
Copies current selection to clipboard and clears from selection
clear
Explanation:
Clears current selection
paste
Explanation:
Pastes from clipboard into current selection
selectAll
Explanation:
Selects all
setTitle
Explanation:
Sets the title
Parameters:
[title]
sendScript
Explanation:
Presents dialog through which user can send commands to the module in charge of the window
toggleTileOutWindow
Explanation:
Toggles whether this window is tiled out or not
togglePopOutWindow
Explanation:
Toggles whether this window is popped out or not
showPage
Explanation:
Sets which page of the window (graphics, text, explanations, parameters, employee tree, etc.) is showing
Parameters:
[page number]
printWindow
Explanation:
Prints the contents of the window
printToFit
Explanation:
Prints the contents of the window to fit a page
printToPDF
Explanation:
Sends the contents of the window to a PDF file
openPrintWindowToFit
Explanation:
Opens the print window (for cases where the printing calls are separated)
openPrintWindow
Explanation:
Opens the print window (for cases where the printing calls are separated)
doPrintWindow
Explanation:
Prints the window (for cases where the printing calls are separated)
closePrintWindow
Explanation:
Closes the print window (for cases where the printing calls are separated)
getToolPalette
Explanation:
Returns the tool palette of the window
cloneWindow
Explanation:
Clones the window if possible
saveMacroForWindow
Explanation:
Saves a macro that serves as a macro to reproduce an analysis or window
saveMacroForAnalysis
Explanation:
Saves a macro that serves as a macro to reproduce an analysis or window
saveTextToFile
Explanation:
Saves the text version of the window to a file
Parameters:
[file name]
appendTextToFile
Explanation:
Appends the text version of the window to an existing file
Parameters:
[file name]
toggleInfoBar
Explanation:
Toggles whether the information bar at the top of the window is shown or not
onInfoBar
Explanation:
Shows the information bar at the top of the window
offInfoBar
Explanation:
Hides the information bar at the top of the window
doMacro
Explanation:
Executes the macro file
Parameters:
[file name]
getOwnerModule
Explanation:
Returns the module owning the window
setSize
Explanation:
Sets the size of the window
Parameters:
[width in pixels][height in pixels]
setExplanationSize
Explanation:
Sets the height of the explanation area
Parameters:
[height in pixels]
setAnnotationSize
Explanation:
Sets the height of the annotation area
Parameters:
[height in pixels]
setLocation
Explanation:
Sets the location of the window
Parameters:
[x coordinate of upper left][y coordinate of upper left]
setFont
Explanation:
Sets the font of the window
Parameters:
[name of font]
setFontSize
Explanation:
Sets the font size of the window
Parameters:
[font size]
setFontIncExp
Explanation:
Sets the font size difference of the explanation area
Parameters:
[font increment]
setFontIncAnnot
Explanation:
Sets the font size difference of the annotations area
Parameters:
[font increment]
listEmployees
Explanation:
Dumps to the log a list of the employees of the owner module
MesquitePanel
setFont
Explanation:
Sets the font of the panel
Parameters:
[font name]
setFontSize
Explanation:
Sets the font size of the panel
Parameters:
[font size]
setBounds
Explanation:
Sets the bounds of the panel, in pixels
Parameters:
[x (left bound)] [y (upper bound)] [width] [height]
mouseDown
Explanation:
Mouse down
Parameters:
[modifiers as integer][click count][when][x][y]
mouseUp
Explanation:
Mouse up
Parameters:
[modifiers as integer][x][y]
mouseDrag
Explanation:
Mouse drag
Parameters:
[modifiers as integer][x][y]
mouseMoved
Explanation:
Mouse moved
Parameters:
[modifiers as integer][x][y]
mouseEntered
Explanation:
Mouse entered
Parameters:
[modifiers as integer][x][y]
mouseExited
Explanation:
Mouse exited
Parameters:
[modifiers as integer][x][y]
mouseClicked
Explanation:
Mouse clicked
Parameters:
[modifiers as integer][x][y]
fileStringDropped
Explanation:
File String Dropped into Panel
Parameters:
[ObjectContainer ID]
filesDropped
Explanation:
Files Dropped into Panel
Parameters:
[ObjectContainer ID]