Module: Character Matrix Editor

Full package name: mesquite.charMatrices.BasicDataWindowMaker.BasicDataWindowMaker
Duty: Data Window Maker (mesquite.lib.duties.DataWindowMaker)

Module Explanation

Makes editor windows to edit character data.

Author(s): Wayne P. Maddison and David R. Maddison
Version 3.70

Commands of Character Matrix Editor

getDataSet
- Explanation: Returns the data matrix shown by the data window
hideWindow
- Explanation: Hides the data matrix window
makeWindow
- Explanation: Makes a data editor window (but doesn't display it)
- Parameters: [number or reference string of data set to be shown]
logLastResultString
- Explanation: Logs last result string
getLastResultString
- Explanation: Returns last result string
getLastResult
- Explanation: Returns last MesquiteNumber result
renameMatrix
- Explanation: Renames the matrix
- Parameters: [name of matrix]
getInfoPanel
- Explanation: Returns the matrix info panel
nextMatrix
- Explanation: Goes to the next matrix
previousMatrix
- Explanation: Goes to the previous matrix
toggleInfoPanel
- Explanation: Toggles whether the info panel is on
toggleEditingNotPermitted
- Explanation: Toggles whether editing is permitted or not
selectSequence
- Explanation: Selects sequence
- Parameters: [number of taxon][number of starting site][number of ending site]
showTaxon
- Explanation: Shows taxon
- Parameters: [id of taxa block][number of taxon]
selectTaxon
- Explanation: Selects taxon
- Parameters: [number of taxon]
selectCharacter
- Explanation: Selects character
- Parameters: [number of character]
deleteMatrix
- Explanation: Deletes the matrix
setUnassignedSymbol
- Explanation: Allows one to set the missing data symbol
setInapplicableSymbol
- Explanation: Allows one to set the inapplicable symbol
showStateNamesEditor
- Explanation: Shows the state names editor
showList
- Explanation: Shows the list of characters
showTaxaList
- Explanation: Shows the list of taxa
setTool
- Explanation: Sets the current tool
- Parameters: [name of tool]
toggleLinkedScrolling
- Explanation: Toggles whether scroll is of linked tables or not.
- Parameters: [on = linked; off]
toggleScrollLinkedTables
- Explanation: Toggles whether scroll is of linked tables or not.
- Parameters: [on = linked; off]
toggleDiagonal
- Explanation: Toggles whether character names are shown diagonally.
- Parameters: [on = diagonal; off]
setDiagonalHeight
- Explanation: Sets height of the column names area when in diagonal mode
- Parameters: [height]
scrollToolOptions
- Explanation: Present the popup menu to select options for scroll to similar tool
simScroll
- Explanation: Scrolls to next similar characters
- Parameters: [column touched] [row touched] [percent horizontal] [percent vertical] [modifiers]
setBackground
- Explanation: Sets background color of matrix
- Parameters: [name of color]
deleteSelectedDataInfoStrips
- Explanation: Deletes the selected rows
hireDataInfoStrip
- Explanation: Hires a DataColumnNamesAssistant module for displaying info strips
- Parameters: [name of module]
assignColor
- Explanation: Assigns color assigned to selected cells
- Parameters: [name of color]
removeColor
- Explanation: Removes color assigned from selected cells
findFootnoteString
- Explanation: Finds footnote containing string, selects cell and ensures it is shown
findAgain
- Explanation: Finds footnote containing string, selects cell and ensures it is shown
moveSelection
- Explanation: Not functioning
addCharacters
- Explanation: Adds or inserts characters into matrix
- Parameters: [character number after which new characters to be inserted] [number of new characters]
deleteCharacters
- Explanation: Deletes characters
- Parameters: [first character to be deleted] [number of characters]
excludeSelectedCharacters
- Explanation: Excludes selected characters
- Parameters: [] []
includeSelectedCharacters
- Explanation: Includes selected characters
- Parameters: [] []
addTaxa
- Explanation: Adds taxa
- Parameters: [taxon number after which new taxa to be inserted] [number of new taxa]
deleteTaxa
- Explanation: Deletes taxa
- Parameters: [first taxon to be deleted] [number of taxa]
moveCharsTo
- Explanation: Moves the selected characters
- Parameters: [column to move after; -1 if at start]
moveTaxaTo
- Explanation: Moves the selected taxa
- Parameters: [row to move after; -1 if at start]
moveSelectedBlock
- Explanation: Moves the selected block
- Parameters: [number of characters to move]
moveFootnotes
- Explanation: Moves the footnotes of the selected characters
- Parameters: [column to move after; -1 if at start]
doUtility
- Explanation: Hires utility module to operate on the data
- Parameters: [name of module]
doNames
- Explanation: Hires utility module to alter names of the taxa
- Parameters: [name of module]
doTaxonUtility
- Explanation: Hires utility module to operate on the taxa
- Parameters: [name of module]
setColumnWidth
- Explanation: Sets width of columns of matrix
- Parameters: [width]
toggleColorCell
- Explanation: Sets whether or not cells of matrix are colored (no longer used)
- Parameters: [on]
colorCells
- Explanation: Sets by what the cells in the matrix are colored
- Parameters: [name of module]
colorText
- Explanation: Sets by what the text in the matrix are colored
- Parameters: [name of module]
colorRowNames
- Explanation: Sets by what the row name cells in the matrix are colored
- Parameters: [name of module]
colorColumnNames
- Explanation: Sets by what the column name cells in the matrix are colored
- Parameters: [name of module]
forceAutosize
- Explanation: Forces the columns to auto-size
toggleShowStates
- Explanation: Sets whether or not states are to be written into cells
- Parameters: [on or off]
toggleReduceCellBorders
- Explanation: Sets whether or not cell borders should be reduced
- Parameters: [on or off]
toggleShowDefaultCharNames
- Explanation: Sets whether or not default character names are shown
- Parameters: [on or off]
toggleAutoWCharNames
- Explanation: Sets whether or not autosize is to use character names also
- Parameters: [on or off]
toggleAutoTaxonNames
- Explanation: Sets whether or not taxon name column is to be autosized
- Parameters: [on or off]
toggleConstrainCW
- Explanation: Sets whether or not column widths are constrained
- Parameters: [on or off]
toggleTight
- Explanation: Sets whether or not columns are drawn as narrowly as possible
- Parameters: [on or off]
toggleThinRows
- Explanation: Sets whether or not rows are drawn as narrowly as possible
- Parameters: [on or off]
toggleInterleaved
- Explanation: Sets whether or not to interleave the matrix when writing
- Parameters: [on or off]
toggleShowChanges
- Explanation: Sets whether or not changes since last save are to be highlighted
- Parameters: [on or off]
toggleSeparateLines
- Explanation: Sets whether or not states are listed on separate lines in explanation
- Parameters: [on or off]
toggleShowNames
- Explanation: Sets whether or not full names are shown in the cells of matrix
- Parameters: [on or off]
toggleShowTaxonNames
- Explanation: Sets whether or not taxon names are shown
- Parameters: [on or off]
toggleAllowAutosize
- Explanation: Sets whether or not auto-sizing of columns occurs
- Parameters: [on or off]
toggleBirdsEye
- Explanation: Sets whether or not birds eye view is shown
- Parameters: [on or off]
toggleColorOnlyTaxonNames
- Explanation: Sets whether or not only taxon names are colored
- Parameters: [on or off]
toggleShowPaleGrid
- Explanation: Sets whether or not the grid is drawn in pale gray
- Parameters: [on or off]
toggleShowPaleCellColors
- Explanation: Sets whether or not the cell colors are pale.
- Parameters: [on or off]
toggleShowPaleExcluded
- Explanation: Sets whether or not excluded characters are pale.
- Parameters: [on or off]
togglePaleInapplicable
- Explanation: Sets whether or not gaps are pale.
- Parameters: [on or off]
togglePaleMissing
- Explanation: Sets whether or not missing data are pale.
- Parameters: [on or off]
toggleShowBoldCellText
- Explanation: Sets whether or not the text of cells is shown in bold face.
- Parameters: [on or off]
birdsEyeWidth
- Explanation: Sets width of columns of matrix for bird's eye view
- Parameters: [width]
toggleColorsPanel
- Explanation: Sets whether or not the color legend panel is shown
- Parameters: [on = shown; off]
newAssistant
- Explanation: Hires new data editor assistant module
- Parameters: [name of module]
findString
- Explanation: Finds cell containing string, selects it and ensures it is shown
findAgain
- Explanation: Finds cell containing string, selects it and ensures it is shown
undo
- Explanation: Undoes the previous change in the window
setToPreviousTool
- Explanation: Sets the tool to the previous tool.
showSnapshot
- Explanation: Shows the commands needed to put window and its modules into their current states
text
- Explanation: Put text version of window into log
selectTree
- Explanation: Selects tree
- Parameters: [number of tree][id of tree block]
touchTaxon
- Explanation: Touches taxon (selects it and shows it if possible)
- Parameters: [number of taxon][id of taxa block]
selectCharacter
- Explanation: Selects character
- Parameters: [number of character][id of character matrix]