com.sun.electric.tool.user
Class User

java.lang.Object
  extended by com.sun.electric.tool.Tool
      extended by com.sun.electric.tool.Listener
          extended by com.sun.electric.tool.user.User
All Implemented Interfaces:
Changes, java.lang.Comparable

public class User
extends Listener

This is the User Interface tool.


Nested Class Summary
static class User.ColorPrefType
          COLOR PREFERENCES
 
Field Summary
static Variable.Key FRAME_COMPANY_NAME
          key of Variable holding cell company name.
static Variable.Key FRAME_DESIGNER_NAME
          key of Variable holding cell designer name.
static Variable.Key FRAME_LAST_CHANGED_BY
          key of Variable holding user who last changed the cell.
static Variable.Key FRAME_PROJECT_NAME
          key of Variable holding cell project name.
static Variable.Key FRAME_SIZE
          key of Variable holding cell frame information.
 
Fields inherited from class com.sun.electric.tool.Tool
prefs
 
Method Summary
static void addRecentlyOpenedLibrary(java.lang.String s)
          Add a file path (no extension) to a list of recently opened libraries.
static void clearChangedInWindow(EditWindow wnd)
          Method to reset the area of a window that has been changed.
static void clearRecentlyOpenedLibraries()
          Clear the list of recently opened libraries.
 void endBatch(Snapshot oldSnapshot, Snapshot newSnapshot, boolean undoRedo)
          Handles database changes of a Job.
static void fixStaleCellReferences(IdMapper idMapper)
          Reloading oe renaming libraries has the side affect that any EditWindows containing cells that were reloaded now point to old, unlinked cells instead of the new ones.
static Dimension2D getAlignmentToGrid()
          Method to return the default alignment of objects to the grid.
static int getAlignmentToGridIndex()
          Method to return index of the current alignment.
static Dimension2D[] getAlignmentToGridVector()
          Method to return an array of five grid alignment values.
static double getAlphaBlendingOvercolorLimit()
          Method to tell the scale of EditWindow when use overcolor in alpha blending color composite.
static TextUtils.UnitScale getAmperageUnits()
          Method to get current amperage (current) units.
static TextUtils.UnitScale getCapacitanceUnits()
          Method to get current capacitance units.
static java.awt.geom.Rectangle2D getChangedInWindow(EditWindow wnd)
          Method to tell which area of a window has been changed.
static int getColor(User.ColorPrefType pref)
          Method to get the color of a given special layer on the display.
 ArcProto getCurrentArcProto()
          Method to return the "current" ArcProto, as maintained by the user interface.
 NodeProto getCurrentNodeProto()
          Method to return the "current" NodeProto, as maintained by the user interface.
static java.lang.String getDefaultFont()
          Method to get the default font to use on the display.
static java.awt.Point getDefaultMessagesPos()
          Method to tell the default position of the messages window.
static java.awt.Dimension getDefaultMessagesSize()
          Method to tell the default size of the messages window.
static java.lang.String getDefaultTechnology()
          Method to get default technique in Tech Palette.
static Setting getDefaultTechnologySetting()
          Returns project preference to tell default technique in Tech Palette.
static java.lang.String getDefaultTextCellFont()
          Method to get the default font to use when editing textual cells.
static int getDefaultTextCellSize()
          Method to tell the size of text in textual cells.
static java.lang.String getDefaultTextExternalEditor()
          Method to get the program to invoke when externally editing textual cells.
static java.awt.Point getDefaultWindowPos()
          Method to tell the default position of top-level windows.
static java.awt.Dimension getDefaultWindowSize()
          Method to tell the default size of top-level windows.
static int getDefaultWindowTab()
          Method to tell the default tab to show.
static int getDefGridXBoldFrequency()
          Method to return the default frequency of bold grid dots in the X direction.
static double getDefGridXSpacing()
          Method to return the default spacing of grid dots in the X direction.
static int getDefGridYBoldFrequency()
          Method to return the default frequency of bold grid dots in the Y direction.
static double getDefGridYSpacing()
          Method to return the default spacing of grid dots in the Y direction.
static int getDisplayAlgorithm()
          Method to tell which display algorithm to use.
static int getDisplayStyle()
          Method to tell the initial display style for Electric.
static TextUtils.UnitScale getDistanceUnits()
          Method to get current distance units.
static int getErrorLimit()
          Method to tell the maximum number of errors to log.
static int getExportDisplayLevel()
          Method to tell how to display exports.
static double getFactoryAlphaBlendingOvercolorLimit()
          Method to tell the scale of EditWindow when use overcolor in alpha blending color composite, by default.
static TextUtils.UnitScale getFactoryAmperageUnits()
          Method to get default amperage (current) units.
static TextUtils.UnitScale getFactoryCapacitanceUnits()
          Method to get default capacitance units.
static java.lang.String getFactoryDefaultFont()
          Method to get the factory default font to use on the display.
static java.lang.String getFactoryDefaultTextCellFont()
          Method to get the factory default font to use when editing textual cells.
static int getFactoryDefaultTextCellSize()
          Method to tell the size of text in textual cells, by default.
static java.lang.String getFactoryDefaultTextExternalEditor()
          Method to get the program to invoke when externally editing textual cells, by default.
static int getFactoryDefGridXBoldFrequency()
          Method to return the default frequency of bold grid dots in the X direction (factory setting).
static double getFactoryDefGridXSpacing()
          Method to return the default spacing of grid dots in the X direction (factory setting).
static int getFactoryDefGridYBoldFrequency()
          Method to return the default frequency of bold grid dots in the Y direction (factory setting).
static double getFactoryDefGridYSpacing()
          Method to return the default spacing of grid dots in the Y direction (factory setting).
static int getFactoryDisplayAlgorithm()
          Method to tell which display algorithm to use, by default.
static int getFactoryDisplayStyle()
          Method to tell the initial display style for Electric, by default.
static TextUtils.UnitScale getFactoryDistanceUnits()
          Method to get default distance units.
static int getFactoryErrorLimit()
          Method to tell the maximum number of errors to log, by default.
static java.lang.String getFactoryFrameCompanyName()
          Method to return the company name to use in schematic frames, by default.
static java.lang.String getFactoryFrameDesignerName()
          Method to return the designer name to use in schematic frames, by default.
static java.lang.String getFactoryFrameProjectName()
          Method to return the project name to use in schematic frames, by default.
static double getFactoryGlobalTextScale()
          Method to tell the factory default global text scale factor.
static double getFactoryGreekCellSizeLimit()
          Method to tell the ratio of cell size to screen size beyond which no cell greeking happens, by default.
static double getFactoryGreekSizeLimit()
          Method to tell the smallest object that can be drawn, by default.
static int getFactoryIconGenBidirRot()
          Method to tell what angle Bidirectional ports should go on generated icons, by default.
static int getFactoryIconGenBidirSide()
          Method to tell where Bidirectional ports should go on generated icons, by default.
static double getFactoryIconGenBodyTextSize()
          Method to tell the size of body text on generated icons, by default.
static int getFactoryIconGenBottomRot()
          Method to tell what angle Bottom ports should go on generated icons, by default.
static int getFactoryIconGenClockRot()
          Method to tell what angle Clock ports should go on generated icons, by default.
static int getFactoryIconGenClockSide()
          Method to tell where Clock ports should go on generated icons, by default.
static int getFactoryIconGenExportLocation()
          Method to tell where exports should appear along the leads in generated icons, by default.
static int getFactoryIconGenExportPlacement()
          Method to tell how exports are placed in generated icons, by default.
static boolean getFactoryIconGenExportPlacementExact()
          Method to tell whether exports are placed exactly according to schematics, by default.
static int getFactoryIconGenExportStyle()
          Method to tell how the text should appear in generated icons, by default.
static int getFactoryIconGenExportTech()
          Method to tell how exports should be constructed in generated icons, by default.
static int getFactoryIconGenGroundRot()
          Method to tell what angle Ground ports should go on generated icons, by default.
static int getFactoryIconGenGroundSide()
          Method to tell where Ground ports should go on generated icons, by default.
static int getFactoryIconGenInputRot()
          Method to tell what angle Input ports should go on generated icons, by default.
static int getFactoryIconGenInputSide()
          Method to tell where Input ports should go on generated icons, by default.
static int getFactoryIconGenInstanceLocation()
          Method to tell where to place an instance of the generated icons in the original schematic, by default.
static double getFactoryIconGenLeadLength()
          Method to tell how long to make leads in generated icons, by default.
static double getFactoryIconGenLeadSpacing()
          Method to tell how far apart to space leads in generated icons, by default.
static int getFactoryIconGenLeftRot()
          Method to tell what angle Left ports should go on generated icons, by default.
static int getFactoryIconGenOutputRot()
          Method to tell what angle Output ports should go on generated icons, by default.
static int getFactoryIconGenOutputSide()
          Method to tell where Output ports should go on generated icons, by default.
static int getFactoryIconGenPowerRot()
          Method to tell what angle Power ports should go on generated icons, by default.
static int getFactoryIconGenPowerSide()
          Method to tell where Power ports should go on generated icons, by default.
static int getFactoryIconGenRightRot()
          Method to tell what angle Right ports should go on generated icons, by default.
static int getFactoryIconGenTopRot()
          Method to tell what angle Top ports should go on generated icons, by default.
static TextUtils.UnitScale getFactoryInductanceUnits()
          Method to get default inductance units.
static int getFactoryMaxUndoHistory()
          Method to get the maximum number of undos retained in memory, by default.
static int getFactoryMemorySize()
          Method to tell the maximum memory to use for Electric (in megabytes), by default.
static int getFactoryPanningDistance()
          Method to tell the distance to pan when shifting the screen or rolling the mouse wheel, by default.
static double getFactoryPatternedScaleLimit()
          Method to tell the scale of EditWindow when use patterned drawing, by default.
static int getFactoryPermSpace()
          Method to tell the maximum permanent space of 2dn GC to use for Electric (in megatybes), by default.
static TextUtils.UnitScale getFactoryResistanceUnits()
          Method to get default resistance units.
static Technology getFactorySchematicTechnology()
          Method to choose the layout Technology to use when schematics are found, by default.
static TextUtils.UnitScale getFactoryTimeUnits()
          Method to get default time units.
static TextUtils.UnitScale getFactoryVoltageUnits()
          Method to get default voltage units.
static java.lang.String getFrameCompanyName()
          Method to return the company name to use in schematic frames.
static java.lang.String getFrameDesignerName()
          Method to return the designer name to use in schematic frames.
static java.lang.String getFrameProjectName()
          Method to return the project name to use in schematic frames.
static double getGlobalTextScale()
          Method to tell the default global text scale factor.
static double getGreekCellSizeLimit()
          Method to tell the ratio of cell size to screen size beyond which no cell greeking happens.
static double getGreekSizeLimit()
          Method to tell the smallest object that can be drawn.
static int getIconGenBidirRot()
          Method to tell what angle Bidirectional ports should go on generated icons.
static int getIconGenBidirSide()
          Method to tell where Bidirectional ports should go on generated icons.
static double getIconGenBodyTextSize()
          Method to tell the size of body text on generated icons.
static int getIconGenBottomRot()
          Method to tell what angle Bottom ports should go on generated icons.
static int getIconGenClockRot()
          Method to tell what angle Clock ports should go on generated icons.
static int getIconGenClockSide()
          Method to tell where Clock ports should go on generated icons.
static int getIconGenExportLocation()
          Method to tell where exports should appear along the leads in generated icons.
static int getIconGenExportPlacement()
          Method to tell how exports are placed in generated icons.
static boolean getIconGenExportPlacementExact()
          Method to tell whether exports are placed exactly according to schematics.
static int getIconGenExportStyle()
          Method to tell how the text should appear in generated icons.
static int getIconGenExportTech()
          Method to tell how exports should be constructed in generated icons.
static int getIconGenGroundRot()
          Method to tell what angle Ground ports should go on generated icons.
static int getIconGenGroundSide()
          Method to tell where Ground ports should go on generated icons.
static int getIconGenInputRot()
          Method to tell what angle Input ports should go on generated icons.
static int getIconGenInputSide()
          Method to tell where Input ports should go on generated icons.
static int getIconGenInstanceLocation()
          Method to tell where to place an instance of the generated icons in the original schematic.
static double getIconGenLeadLength()
          Method to tell how long to make leads in generated icons.
static double getIconGenLeadSpacing()
          Method to tell how far apart to space leads in generated icons.
static int getIconGenLeftRot()
          Method to tell what angle Left ports should go on generated icons.
static int getIconGenOutputRot()
          Method to tell what angle Output ports should go on generated icons.
static int getIconGenOutputSide()
          Method to tell where Output ports should go on generated icons.
static int getIconGenPowerRot()
          Method to tell what angle Power ports should go on generated icons.
static int getIconGenPowerSide()
          Method to tell where Power ports should go on generated icons.
static int getIconGenRightRot()
          Method to tell what angle Right ports should go on generated icons.
static int getIconGenTopRot()
          Method to tell what angle Top ports should go on generated icons.
static Setting getIncludeDateAndVersionInOutputSetting()
          Returns project preference to tell whether to include the date and Electric version in output files.
static TextUtils.UnitScale getInductanceUnits()
          Method to get current inductance units.
static int getMaxUndoHistory()
          Method to get the maximum number of undos retained in memory
static int getMemorySize()
          Method to tell the maximum memory to use for Electric, in megatybes.
static int getNewNodeRotation()
          Method to return the default rotation of all new nodes.
static int getPanningDistance()
          Method to tell the distance to pan when shifting the screen or rolling the mouse wheel.
static double getPatternedScaleLimit()
          Method to tell the scale of EditWindow when use patterned drawing.
static int getPermSpace()
          Method to tell the maximum permanent space of 2dn GC to use for Electric, in megatybes.
static int getPortDisplayLevel()
          Method to tell how to display ports.
static Setting getPWellProcessLayoutTechnologySetting()
          Method to tell whether the process is a PWell process.
static java.lang.String[] getRecentlyOpenedLibraries()
          Get an array of File paths to recently opened libraries.
static java.lang.String getRegressionPath()
          Method to get the path of the regression tests directory.
static TextUtils.UnitScale getResistanceUnits()
          Method to get current resistance units.
static Technology getSchematicTechnology()
          Method to choose the layout Technology to use when schematics are found.
static Setting getSchematicTechnologySetting()
          Returns project preference to tell the layout Technology to use when schematics are found.
static Setting getSoftTechnologiesSetting()
          Returns project preference with additional technologies.
static TextUtils.UnitScale getTimeUnits()
          Method to get current time units.
static User getUserTool()
          Method to retrieve the singleton associated with the User tool.
static TextUtils.UnitScale getVoltageUnits()
          Method to get current voltage units.
static int getWaveformAnalogPanelHeight()
          Method to tell the height of analog waveform panels.
static int getWaveformDigitalPanelHeight()
          Method to tell the height of digital waveform panels.
static java.lang.String getWorkingDirectory()
          Method to get the path of the current working directory.
 void init()
          Method to initialize the User Interface tool.
static boolean isArcsAutoIncremented()
          Method to tell whether Duplicate/Paste/Array of ArcInsts auto-increments arc names.
static boolean isAutoTechnologySwitch()
          Method to tell whether to switch technologies automatically when changing the current Cell.
static boolean isBeepAfterLongJobs()
          Method to tell whether to beep after long jobs.
static boolean isCheckCellDates()
          Method to tell whether to check Cell dates when placing instances.
static boolean isDimUpperLevelWhenDownInPlace()
          Method to tell whether to dim the upper levels of the display when editing down-in-place.
static boolean isDisallowModificationComplexNodes()
          Method to tell whether complex nodes can be modified.
static boolean isDisallowModificationLockedPrims()
          Method to tell whether locked primitives can be modified.
static boolean isDraggingMustEncloseObjects()
          Method to tell whether dragging a selection rectangle must completely encose objects in order to select them.
static boolean isDupCopiesExports()
          Method to tell whether Duplicate/Paste/Array of NodeInst copies exports.
static boolean isEasySelectionOfCellInstances()
          Method to tell whether cell instances are all be easy-to-select.
static boolean isExtractCopiesExports()
          Method to tell whether Extract of NodeInst copies exports.
static boolean isFactoryArcsAutoIncremented()
          Method to tell whether Duplicate/Paste/Array of ArcInsts auto-increments arc names, by default.
static boolean isFactoryAutoTechnologySwitch()
          Method to tell whether to switch technologies automatically when changing the current Cell, by default.
static boolean isFactoryBeepAfterLongJobs()
          Method to tell whether to beep after long jobs, by default.
static boolean isFactoryCheckCellDates()
          Method to tell whether to check Cell dates when placing instances, by default.
static boolean isFactoryDimUpperLevelWhenDownInPlace()
          Method to tell whether to dim the upper levels of the display when editing down-in-place, by default.
static boolean isFactoryDisallowModificationComplexNodes()
          Method to tell whether complex nodes can be modified by default.
static boolean isFactoryDisallowModificationLockedPrims()
          Method to tell whether locked primitives can be modified by default.
static boolean isFactoryDraggingMustEncloseObjects()
          Method to tell whether dragging a selection rectangle must completely encose objects in order to select them, by default.
static boolean isFactoryDupCopiesExports()
          Method to tell whether Duplicate/Paste/Array of NodeInst copies exports, by default.
static boolean isFactoryEasySelectionOfCellInstances()
          Method to tell whether cell instances are all be easy-to-select by default.
static boolean isFactoryExtractCopiesExports()
          Method to tell whether Extract of NodeInst copies exports, by default.
static boolean isFactoryGridAxesShown()
          Method to return true if grid axes are shown, by default.
static boolean isFactoryHighlightConnectedObjects()
          Method to set whether to highlight objects connected to the selected object, by default.
static boolean isFactoryHighlightInvisibleObjects()
          Method to set whether to highlight objects whose layers are all invisible, by default.
static boolean isFactoryIconGenDrawBody()
          Method to tell whether generated icons should have a body drawn by default.
static boolean isFactoryIconGenDrawLeads()
          Method to tell whether generated icons should have leads drawn by default.
static boolean isFactoryIconGenReverseExportOrder()
          Method to tell whether generated icons should reverse the order of exports, by default.
static boolean isFactoryIconsAlwaysDrawn()
          Method to tell whether generated icon exports should be "always drawn" by default.
static boolean isFactoryJobVerboseMode()
          Method to tell if jobs are described in messages window (verbose mode), by default.
static boolean isFactoryLegacyComposite()
          Method to tell whether to use lagacy composite in LayerDrawing, by default.
static boolean isFactoryMouseOverHighlightingEnabled()
          Method to tell whether dragging a selection rectangle must completely encose objects in order to select them, by default.
static boolean isFactoryMoveAfterDuplicate()
          Method to tell whether to move objects after duplicating them, by default.
static boolean isFactoryMoveNodeWithExport()
          Method to tell whether to move a node when its export name moves, by default.
static boolean isFactoryPlaceCellCenter()
          Method to tell whether to place a Cell-Center primitive in every newly created Cell, by default.
static boolean isFactoryPlayClickSoundsWhenCreatingArcs()
          Method to tell whether to play a "click" sound when an arc is created, by default.
static boolean isFactoryPromptForIndexWhenDescending()
          Method to tell whether to prompt the user for an array index when descending into arrayed nodes, by default.
static boolean isFactoryReconstructArcsAndExportsToDeletedCells()
          Method to tell whether to reconstruct arcs and exports to deleted cell instances, by default.
static boolean isFactoryRotateLayoutTransistors()
          Method to tell if layout transistors are rotated 90 degrees in the menu (and initial placement), by default.
static boolean isFactoryShowFileSelectionForNetlists()
          Method to tell whether to display a file selection dialog before writing netlists, by default.
static boolean isFactoryShowHierarchicalCursorCoordinates()
          Method to tell whether to show hierarchical cursor coordinates as they move in the edit window, by default.
static boolean isFactorySideBarOnRight()
          Method to tell whether to place the side bar on the right by default (factory setting).
static boolean isFactorySnapshotLogging()
          Method to tell whether to perform snapshot logging in a temporary file, by default.
static boolean isFactoryUseCellGreekingImages()
          Method to tell whether to use small images when greeking cells, by default.
static boolean isFactoryUseClientServer()
          Method to tell whether to use a separate client and server for Electric, by default.
static boolean isFactoryUseTwoJVMs()
          Method to tell whether to use two JVMs when running Electric, by default.
static boolean isGridAxesShown()
          Method to return true if grid axes are shown.
static boolean isHighlightConnectedObjects()
          Method to set whether to highlight objects connected to the selected object
static boolean isHighlightInvisibleObjects()
          Method to set whether to highlight objects whose layers are all invisible.
static boolean isIconGenDrawBody()
          Method to tell whether generated icons should have a body drawn.
static boolean isIconGenDrawLeads()
          Method to tell whether generated icons should have leads drawn.
static boolean isIconGenReverseExportOrder()
          Method to tell whether generated icons should reverse the order of exports.
static boolean isIconsAlwaysDrawn()
          Method to tell whether generated icon exports should be "always drawn".
static boolean isIncludeDateAndVersionInOutput()
          Method to tell whether to include the date and Electric version in output files.
static boolean isJobVerboseMode()
          Method to tell if jobs are described in messages window (verbose mode) The default is "false".
static boolean isLegacyComposite()
          Method to tell whether to use lagacy composite in LayerDrawing.
static boolean isMouseOverHighlightingEnabled()
          Method to tell whether dragging a selection rectangle must completely encose objects in order to select them.
static boolean isMoveAfterDuplicate()
          Method to tell whether to move objects after duplicating them.
static boolean isMoveNodeWithExport()
          Method to tell whether to move a node when its export name moves.
static boolean isNewNodeMirrorX()
          Method to tell whether new nodes are mirrored in X.
static boolean isPlaceCellCenter()
          Method to tell whether to place a Cell-Center primitive in every newly created Cell.
static boolean isPlayClickSoundsWhenCreatingArcs()
          Method to tell whether to play a "click" sound when an arc is created.
static boolean isPromptForIndexWhenDescending()
          Method to tell whether to prompt the user for an array index when descending into arrayed nodes.
static boolean isPWellProcessLayoutTechnology()
           
static boolean isReconstructArcsAndExportsToDeletedCells()
          Method to tell whether to reconstruct arcs and exports to deleted cell instances.
static boolean isRotateLayoutTransistors()
          Method to tell if layout transistors are rotated 90 degrees in the menu (and initial placement).
static boolean isShowFileSelectionForNetlists()
          Method to tell whether to display a file selection dialog before writing netlists.
static boolean isShowHierarchicalCursorCoordinates()
          Method to tell whether to show hierarchical cursor coordinates as they move in the edit window.
static boolean isSideBarOnRight()
          Method to tell whether to place the side bar on the right by default.
static boolean isSnapshotLogging()
          Method to tell whether to perform snapshot logging in a temporary file.
static boolean isTextVisibilityOn(AbstractTextDescriptor.TextType textType)
          Method to tell whether to draw text of particular text type.
static boolean isTextVisibilityOnAnnotation()
          Method to tell whether to draw text annotation text.
static boolean isTextVisibilityOnArc()
          Method to tell whether to draw text that resides on arcs.
static boolean isTextVisibilityOnCell()
          Method to tell whether to draw text that resides on the cell.
static boolean isTextVisibilityOnExport()
          Method to tell whether to draw text that resides on exports.
static boolean isTextVisibilityOnInstance()
          Method to tell whether to draw the name of on cell instances.
static boolean isTextVisibilityOnNode()
          Method to tell whether to draw text that resides on nodes.
static boolean isTextVisibilityOnPort()
          Method to tell whether to draw text that resides on ports.
static boolean isUseCellGreekingImages()
          Method to tell whether to use small images when greeking cells.
static boolean isUseClientServer()
          Method to tell whether to use a separate client and server for Electric.
static boolean isUseTwoJVMs()
          Method to tell whether to use two JVMs when running Electric.
static void playSound()
           
static void resetFactoryColor(User.ColorPrefType pref)
          Method to reset to the factory color of a given special layer BACKGROUND: The default is "light gray".
static void setAlignmentToGridVector(Dimension2D[] dist, int current)
          Method to set the default alignment of objects to the grid.
static void setAlphaBlendingOvercolorLimit(double l)
          Method to set the scale of EditWindow when use overcolor in alpha blending color composite.
static void setAmperageUnits(TextUtils.UnitScale us)
          Method to set the current amperage (current) units.
static void setArcsAutoIncremented(boolean on)
          Method to set whether Duplicate/Paste/Array of ArcInsts auto-increments arc names.
static void setAutoTechnologySwitch(boolean on)
          Method to set whether to switch technologies automatically when changing the current Cell.
static void setBeepAfterLongJobs(boolean on)
          Method to set whether to beep after long jobs.
static void setCapacitanceUnits(TextUtils.UnitScale us)
          Method to set the current capacitance units.
static void setCheckCellDates(boolean on)
          Method to set whether to check Cell dates when placing instances.
static void setColor(User.ColorPrefType pref, int color)
          Method to set the color of a given special layer BACKGROUND: color of the background on the display.
 void setCurrentArcProto(ArcProto ap)
          Method to set the "current" ArcProto, as maintained by the user interface.
static void setCurrentLibrary(Library lib)
          Method to switch libraries and handle technology editing details.
 void setCurrentNodeProto(NodeProto np)
          Method to set the "current" NodeProto, as maintained by the user interface.
static void setDefaultMessagesPos(java.awt.Point pt)
          Method to set the default position of the messages window.
static void setDefaultMessagesSize(java.awt.Dimension sz)
          Method to set the default size of the messages window.
static void setDefaultTextCellFont(java.lang.String f)
          Method to set the default font to use when editing textual cells.
static void setDefaultTextCellSize(int s)
          Method to set the size of text in textual cells.
static void setDefaultTextExternalEditor(java.lang.String e)
          Method to set the program to invoke when externally editing textual cells.
static void setDefaultWindowPos(java.awt.Point pt)
          Method to set the default position of top-level windows.
static void setDefaultWindowSize(java.awt.Dimension sz)
          Method to set the default size of top-level windows.
static void setDefaultWindowTab(int t)
          Method to set the default tab to show.
static void setDefGridXBoldFrequency(int dist)
          Method to set the default frequency of bold grid dots in the X direction.
static void setDefGridXSpacing(double dist)
          Method to set the default spacing of grid dots in the X direction.
static void setDefGridYBoldFrequency(int dist)
          Method to set the default frequency of bold grid dots in the Y direction.
static void setDefGridYSpacing(double dist)
          Method to set the default spacing of grid dots in the Y direction.
static void setDimUpperLevelWhenDownInPlace(boolean dim)
          Method to set whether to dim the upper levels of the display when editing down-in-place.
static void setDisallowModificationComplexNodes(boolean on)
          Method to set whether complex nodes can be modified.
static void setDisallowModificationLockedPrims(boolean on)
          Method to set whether locked primitives can be modified.
static void setDisplayAlgorithm(int w)
          Method to set the display algorithm to use.
static void setDisplayStyle(int s)
          Method to set the initial display style for Electric.
static void setDistanceUnits(TextUtils.UnitScale us)
          Method to set the current distance units.
static void setDraggingMustEncloseObjects(boolean on)
          Method to set whether dragging a selection rectangle must completely encose objects in order to select them.
static void setDupCopiesExports(boolean on)
          Method to set whether Duplicate/Paste/Array of NodeInst copies exports.
static void setEasySelectionOfCellInstances(boolean on)
          Method to set whether cell instances are all be easy-to-select.
static void setErrorLimit(int limit)
          Method to set the maximum number of errors to log.
static void setExtractCopiesExports(boolean on)
          Method to set whether Extract of NodeInst copies exports.
static void setFrameCompanyName(java.lang.String c)
          Method to set the company name to use in schematic frames.
static void setFrameDesignerName(java.lang.String c)
          Method to set the designer name to use in schematic frames.
static void setFrameProjectName(java.lang.String c)
          Method to set the project name to use in schematic frames.
static void setGlobalTextScale(double s)
          Method to set the default global text scale factor.
static void setGreekCellSizeLimit(double l)
          Method to set the ratio of cell size to screen size beyond which no cell greeking happens.
static void setGreekSizeLimit(double l)
          Method to set the smallest object that can be drawn.
static void setGridAxesShown(boolean s)
          Method to set if grid axes are shown.
static void setHighlightConnectedObjects(boolean on)
          Method to get whether to highlight objects connected to the selected object
static void setHighlightInvisibleObjects(boolean on)
          Method to get whether to highlight objects whose layers are all invisible.
static void setIconGenBidirRot(int rot)
          Method to set what angle Bidirectional ports should go on generated icons.
static void setIconGenBidirSide(int side)
          Method to set where Bidirectional ports should go on generated icons.
static void setIconGenBodyTextSize(double s)
          Method to set the size of body text on generated icons.
static void setIconGenBottomRot(int rot)
          Method to set what angle Bottom ports should go on generated icons.
static void setIconGenClockRot(int rot)
          Method to set what angle Clock ports should go on generated icons.
static void setIconGenClockSide(int side)
          Method to set where Clock ports should go on generated icons.
static void setIconGenDrawBody(boolean on)
          Method to set whether generated icons should have a body drawn.
static void setIconGenDrawLeads(boolean on)
          Method to set whether generated icons should have leads drawn.
static void setIconGenExportLocation(int loc)
          Method to set how exports should appear along the leads in generated icons.
static void setIconGenExportPlacement(int rot)
          Method to set how exports are placed in generated icons.
static void setIconGenExportPlacementExact(boolean flag)
          Method to set whether exports are placed exactly according to schematics.
static void setIconGenExportStyle(int style)
          Method to set how the text should appear in generated icons.
static void setIconGenExportTech(int t)
          Method to set how exports should be constructed in generated icons.
static void setIconGenGroundRot(int rot)
          Method to set what angle Ground ports should go on generated icons.
static void setIconGenGroundSide(int side)
          Method to set where Ground ports should go on generated icons.
static void setIconGenInputRot(int rot)
          Method to set what angle Input ports should go on generated icons.
static void setIconGenInputSide(int side)
          Method to set where Input ports should go on generated icons.
static void setIconGenInstanceLocation(int loc)
          Method to set where to place an instance of the generated icons in the original schematic.
static void setIconGenLeadLength(double len)
          Method to set how long to make leads in generated icons.
static void setIconGenLeadSpacing(double dist)
          Method to set how far apart to space leads in generated icons.
static void setIconGenLeftRot(int rot)
          Method to set what angle Left ports should go on generated icons.
static void setIconGenOutputRot(int rot)
          Method to set what angle Output ports should go on generated icons.
static void setIconGenOutputSide(int side)
          Method to set where Output ports should go on generated icons.
static void setIconGenPowerRot(int rot)
          Method to set what angle Power ports should go on generated icons.
static void setIconGenPowerSide(int side)
          Method to set where Power ports should go on generated icons.
static void setIconGenReverseExportOrder(boolean on)
          Method to set whether generated icons should reverse the order of exports.
static void setIconGenRightRot(int rot)
          Method to set what angle Right ports should go on generated icons.
static void setIconGenTopRot(int rot)
          Method to set what angle Top ports should go on generated icons.
static void setIconsAlwaysDrawn(boolean on)
          Method to set whether generated icon exports should be "always drawn".
static void setInductanceUnits(TextUtils.UnitScale us)
          Method to set the current inductance units.
static void setJobVerboseMode(boolean on)
          Method to set whether jobs are described in messages window.
static void setLegacyComposite(boolean on)
          Method to set whether to use lagacy composite in LayerDrawing.
static void setMaxUndoHistory(int n)
          Method to set the maximum number of undos retained in memory
static void setMemorySize(int limit)
          Method to set the maximum memory to use for Electric.
static void setMouseOverHighlightingEnabled(boolean on)
          Method to set whether dragging a selection rectangle must completely encose objects in order to select them.
static void setMoveAfterDuplicate(boolean on)
          Method to set whether to move objects after duplicating them.
static void setMoveNodeWithExport(boolean on)
          Method to set whether to move a node when its export name moves.
static void setNewNodeMirrorX(boolean on)
          Method to set whether new nodes are mirrored in X.
static void setNewNodeRotation(int rot)
          Method to set the default rotation of all new nodes.
static void setPanningDistance(int d)
          Method to set the distance to pan when shifting the screen or rolling the mouse wheel.
static void setPatternedScaleLimit(double l)
          Method to set the scale of EditWindow when use patterned drawing.
static void setPermSpace(int limit)
          Method to set the maximum permanent space of 2dn GC to use for Electric.
static void setPlaceCellCenter(boolean on)
          Method to set whether to place a Cell-Center primitive in every newly created Cell.
static void setPlayClickSoundsWhenCreatingArcs(boolean on)
          Method to set whether to play a "click" sound when an arc is created
static void setPromptForIndexWhenDescending(boolean on)
          Method to set whether to prompt the user for an array index when descending into arrayed nodes.
static void setReconstructArcsAndExportsToDeletedCells(boolean on)
          Method to set whether to reconstruct arcs and exports to deleted cell instances.
static void setRegressionPath(java.lang.String s)
          Method to set the path of the regression tests directory.
static void setResistanceUnits(TextUtils.UnitScale us)
          Method to set the current resistance units.
static void setRotateLayoutTransistors(boolean on)
          Method to set whether layout transistors are rotated 90 degrees in the menu (and initial placement).
static void setShowFileSelectionForNetlists(boolean on)
          Method to set whether to display a file selection dialog before writing netlists.
static void setShowHierarchicalCursorCoordinates(boolean on)
          Method to set whether to show hierarchical cursor coordinates as they move in the edit window.
static void setSideBarOnRight(boolean on)
          Method to set whether to place the side bar on the right by default.
static void setSnapshotLogging(boolean on)
          Method to set whether to perform snapshot logging in a temporary file
static void setTimeUnits(TextUtils.UnitScale us)
          Method to set the current time units.
static void setUseCellGreekingImages(boolean on)
          Method to set whether to use small images when greeking cells.
static void setUseClientServer(boolean on)
          Method to set whether to use a separate client and server for Electric
static void setUseTwoJVMs(boolean on)
          Method to set whether to use two JVMs when running Electric.
static void setVoltageUnits(TextUtils.UnitScale us)
          Method to set the current voltage units.
static void setWaveformAnalogPanelHeight(int h)
          Method to set the height of analog waveform panels.
static void setWaveformDigitalPanelHeight(int h)
          Method to set the height of digital waveform panels.
static void setWorkingDirectory(java.lang.String dir)
          Method to set the path of the current working directory.
static void technologyChanged()
          Method called when a technology's parameters change.
 
Methods inherited from class com.sun.electric.tool.Listener
eraseLibrary, examineCell, killObject, modifyArcInst, modifyCell, modifyCellGroup, modifyExport, modifyLibrary, modifyNodeInst, newObject, readLibrary, renameObject, request, slice, startBatch, writeLibrary
 
Methods inherited from class com.sun.electric.tool.Tool
clearAnalysis, clearBackground, clearFixErrors, clearIncremental, clearOn, clearSynthesis, compareTo, findTool, getIndex, getListeners, getName, getNumTools, getProjectSettings, getTools, initAllTools, isAnalysis, isBackground, isFixErrors, isIncremental, isOn, isSynthesis, setAnalysis, setBackground, setFixErrors, setIncremental, setOn, setSynthesis, setVarInJob, testAll, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FRAME_SIZE

public static final Variable.Key FRAME_SIZE
key of Variable holding cell frame information.


FRAME_COMPANY_NAME

public static final Variable.Key FRAME_COMPANY_NAME
key of Variable holding cell company name.


FRAME_DESIGNER_NAME

public static final Variable.Key FRAME_DESIGNER_NAME
key of Variable holding cell designer name.


FRAME_LAST_CHANGED_BY

public static final Variable.Key FRAME_LAST_CHANGED_BY
key of Variable holding user who last changed the cell.


FRAME_PROJECT_NAME

public static final Variable.Key FRAME_PROJECT_NAME
key of Variable holding cell project name.

Method Detail

init

public void init()
Method to initialize the User Interface tool.

Specified by:
init in interface Changes
Overrides:
init in class Tool

getUserTool

public static User getUserTool()
Method to retrieve the singleton associated with the User tool.

Returns:
the User tool.

endBatch

public void endBatch(Snapshot oldSnapshot,
                     Snapshot newSnapshot,
                     boolean undoRedo)
Handles database changes of a Job.

Specified by:
endBatch in interface Changes
Specified by:
endBatch in class Listener
Parameters:
oldSnapshot - database snapshot before Job.
newSnapshot - database snapshot after Job and constraint propagation.
undoRedo - true if Job was Undo/Redo job.

fixStaleCellReferences

public static void fixStaleCellReferences(IdMapper idMapper)
Reloading oe renaming libraries has the side affect that any EditWindows containing cells that were reloaded now point to old, unlinked cells instead of the new ones. This method checks for this state and fixes it.

Parameters:
idMapper - mapping of Library/Cell/Export ids, null if the library was renamed.

getChangedInWindow

public static java.awt.geom.Rectangle2D getChangedInWindow(EditWindow wnd)
Method to tell which area of a window has been changed.

Parameters:
wnd - the EditWindow in question.
Returns:
the area (in database coordinates) that have been modified and demand redisplay.

clearChangedInWindow

public static void clearChangedInWindow(EditWindow wnd)
Method to reset the area of a window that has been changed. Call this after redisplaying that area so that nothing is queued for redraw.

Parameters:
wnd - the EditWindow in question.

technologyChanged

public static void technologyChanged()
Method called when a technology's parameters change. All cells that use the technology must be recached.


getCurrentNodeProto

public NodeProto getCurrentNodeProto()
Method to return the "current" NodeProto, as maintained by the user interface.

Returns:
the "current" NodeProto, as maintained by the user interface.

setCurrentNodeProto

public void setCurrentNodeProto(NodeProto np)
Method to set the "current" NodeProto, as maintained by the user interface.

Parameters:
np - the new "current" NodeProto.

getCurrentArcProto

public ArcProto getCurrentArcProto()
Method to return the "current" ArcProto, as maintained by the user interface. The current ArcProto is highlighted with a bolder red border in the component menu on the left.

Returns:
the "current" ArcProto, as maintained by the user interface.

setCurrentArcProto

public void setCurrentArcProto(ArcProto ap)
Method to set the "current" ArcProto, as maintained by the user interface. The current ArcProto is highlighted with a bolder red border in the component menu on the left.

Parameters:
ap - the new "current" ArcProto.

playSound

public static void playSound()

setCurrentLibrary

public static void setCurrentLibrary(Library lib)
Method to switch libraries and handle technology editing details.


getDefaultTechnology

public static java.lang.String getDefaultTechnology()
Method to get default technique in Tech Palette. The default is "mocmos".

Returns:
the default technology to use in Tech Palette

getDefaultTechnologySetting

public static Setting getDefaultTechnologySetting()
Returns project preference to tell default technique in Tech Palette.

Returns:
project preference to tell default technique in Tech Palette.

getSchematicTechnology

public static Technology getSchematicTechnology()
Method to choose the layout Technology to use when schematics are found. This is important in Spice deck generation (for example) because the Spice primitives may say "2x3" on them, but a real technology (such as "mocmos") must be found to convert these pure numbers to real spacings for the deck. The default is the MOSIS CMOS technology.

Returns:
the Technology to use when schematics are found.

getSchematicTechnologySetting

public static Setting getSchematicTechnologySetting()
Returns project preference to tell the layout Technology to use when schematics are found. This is important in Spice deck generation (for example) because the Spice primitives may say "2x3" on them, but a real technology (such as "mocmos") must be found to convert these pure numbers to real spacings for the deck.

Returns:
project preference to tell the Technology to use when schematics are found.

getFactorySchematicTechnology

public static Technology getFactorySchematicTechnology()
Method to choose the layout Technology to use when schematics are found, by default.

Returns:
the Technology to use when schematics are found, by default.

isIncludeDateAndVersionInOutput

public static boolean isIncludeDateAndVersionInOutput()
Method to tell whether to include the date and Electric version in output files. The default is "true".

Returns:
true if the system should include the date and Electric version in output files.

getIncludeDateAndVersionInOutputSetting

public static Setting getIncludeDateAndVersionInOutputSetting()
Returns project preference to tell whether to include the date and Electric version in output files.

Returns:
project preference to tell whether to include the date and Electric version in output files.

getPWellProcessLayoutTechnologySetting

public static Setting getPWellProcessLayoutTechnologySetting()
Method to tell whether the process is a PWell process. If true, it will ignore the pwell spacing rule. The default is "true".

Returns:
true if the process is PWell

isPWellProcessLayoutTechnology

public static boolean isPWellProcessLayoutTechnology()

getSoftTechnologiesSetting

public static Setting getSoftTechnologiesSetting()
Returns project preference with additional technologies.

Returns:
project preference with additional technologies.

isIconGenDrawLeads

public static boolean isIconGenDrawLeads()
Method to tell whether generated icons should have leads drawn. The default is "true".

Returns:
true if generated icons should have leads drawn.

setIconGenDrawLeads

public static void setIconGenDrawLeads(boolean on)
Method to set whether generated icons should have leads drawn.

Parameters:
on - true if generated icons should have leads drawn.

isFactoryIconGenDrawLeads

public static boolean isFactoryIconGenDrawLeads()
Method to tell whether generated icons should have leads drawn by default.

Returns:
true if generated icons should have leads drawn by default.

isIconsAlwaysDrawn

public static boolean isIconsAlwaysDrawn()
Method to tell whether generated icon exports should be "always drawn". Exports that are "always drawn" have their text shown on instances, even when those exports are connected or further exported. The default is "false".

Returns:
true if generated icon exports should be "always drawn".

setIconsAlwaysDrawn

public static void setIconsAlwaysDrawn(boolean on)
Method to set whether generated icon exports should be "always drawn". Exports that are "always drawn" have their text shown on instances, even when those exports are connected or further exported.

Parameters:
on - true if generated icon exports should be "always drawn".

isFactoryIconsAlwaysDrawn

public static boolean isFactoryIconsAlwaysDrawn()
Method to tell whether generated icon exports should be "always drawn" by default. Exports that are "always drawn" have their text shown on instances, even when those exports are connected or further exported.

Returns:
true if generated icon exports should be "always drawn" by default.

isIconGenDrawBody

public static boolean isIconGenDrawBody()
Method to tell whether generated icons should have a body drawn. The body is just a rectangle. The default is "true".

Returns:
true if generated icons should have a body drawn.

setIconGenDrawBody

public static void setIconGenDrawBody(boolean on)
Method to set whether generated icons should have a body drawn. The body is just a rectangle.

Parameters:
on - true if generated icons should have a body drawn.

isFactoryIconGenDrawBody

public static boolean isFactoryIconGenDrawBody()
Method to tell whether generated icons should have a body drawn by default. The body is just a rectangle.

Returns:
true if generated icons should have a body drawn by default.

getIconGenBodyTextSize

public static double getIconGenBodyTextSize()
Method to tell the size of body text on generated icons. The default is 2 unit.

Returns:
the size of body text on generated icons.

setIconGenBodyTextSize

public static void setIconGenBodyTextSize(double s)
Method to set the size of body text on generated icons.

Parameters:
s - the size of body text on generated icons.

getFactoryIconGenBodyTextSize

public static double getFactoryIconGenBodyTextSize()
Method to tell the size of body text on generated icons, by default.

Returns:
the size of body text on generated icons, by default.

isIconGenReverseExportOrder

public static boolean isIconGenReverseExportOrder()
Method to tell whether generated icons should reverse the order of exports. Normally, exports are drawn top-to-bottom alphabetically. The default is "false".

Returns:
true if generated icons should reverse the order of exports.

setIconGenReverseExportOrder

public static void setIconGenReverseExportOrder(boolean on)
Method to set whether generated icons should reverse the order of exports. Normally, exports are drawn top-to-bottom alphabetically.

Parameters:
on - true if generated icons should reverse the order of exports.

isFactoryIconGenReverseExportOrder

public static boolean isFactoryIconGenReverseExportOrder()
Method to tell whether generated icons should reverse the order of exports, by default. Normally, exports are drawn top-to-bottom alphabetically.

Returns:
true if generated icons should reverse the order of exports, by default.

getIconGenInputSide

public static int getIconGenInputSide()
Method to tell where Input ports should go on generated icons.

Returns:
information about where Input ports should go on generated icons. 0: left (the default) 1: right 2: top 3: bottom

setIconGenInputSide

public static void setIconGenInputSide(int side)
Method to set where Input ports should go on generated icons.

Parameters:
side - information about where Input ports should go on generated icons. 0: left 1: right 2: top 3: bottom

getFactoryIconGenInputSide

public static int getFactoryIconGenInputSide()
Method to tell where Input ports should go on generated icons, by default.

Returns:
information about where Input ports should go on generated icons, by default. 0: left 1: right 2: top 3: bottom

getIconGenOutputSide

public static int getIconGenOutputSide()
Method to tell where Output ports should go on generated icons.

Returns:
information about where Output ports should go on generated icons. 0: left 1: right (the default) 2: top 3: bottom

setIconGenOutputSide

public static void setIconGenOutputSide(int side)
Method to set where Output ports should go on generated icons.

Parameters:
side - information about where Output ports should go on generated icons. 0: left 1: right (the default) 2: top 3: bottom

getFactoryIconGenOutputSide

public static int getFactoryIconGenOutputSide()
Method to tell where Output ports should go on generated icons, by default.

Returns:
information about where Output ports should go on generated icons, by default. 0: left 1: right 2: top 3: bottom

getIconGenBidirSide

public static int getIconGenBidirSide()
Method to tell where Bidirectional ports should go on generated icons.

Returns:
information about where Bidirectional ports should go on generated icons. 0: left 1: right 2: top (the default) 3: bottom

setIconGenBidirSide

public static void setIconGenBidirSide(int side)
Method to set where Bidirectional ports should go on generated icons.

Parameters:
side - information about where Bidirectional ports should go on generated icons. 0: left 1: right 2: top (the default) 3: bottom

getFactoryIconGenBidirSide

public static int getFactoryIconGenBidirSide()
Method to tell where Bidirectional ports should go on generated icons, by default.

Returns:
information about where Bidirectional ports should go on generated icons, by default. 0: left 1: right 2: top 3: bottom

getIconGenPowerSide

public static int getIconGenPowerSide()
Method to tell where Power ports should go on generated icons.

Returns:
information about where Power ports should go on generated icons. 0: left 1: right 2: top 3: bottom (the default)

setIconGenPowerSide

public static void setIconGenPowerSide(int side)
Method to set where Power ports should go on generated icons.

Parameters:
side - information about where Power ports should go on generated icons. 0: left 1: right 2: top 3: bottom (the default)

getFactoryIconGenPowerSide

public static int getFactoryIconGenPowerSide()
Method to tell where Power ports should go on generated icons, by default.

Returns:
information about where Power ports should go on generated icons, by default. 0: left 1: right 2: top 3: bottom

getIconGenGroundSide

public static int getIconGenGroundSide()
Method to tell where Ground ports should go on generated icons.

Returns:
information about where Ground ports should go on generated icons. 0: left 1: right 2: top 3: bottom (the default)

setIconGenGroundSide

public static void setIconGenGroundSide(int side)
Method to set where Ground ports should go on generated icons.

Parameters:
side - information about where Ground ports should go on generated icons. 0: left 1: right 2: top 3: bottom (the default)

getFactoryIconGenGroundSide

public static int getFactoryIconGenGroundSide()
Method to tell where Ground ports should go on generated icons, by default.

Returns:
information about where Ground ports should go on generated icons, by default. 0: left 1: right 2: top 3: bottom

getIconGenClockSide

public static int getIconGenClockSide()
Method to tell where Clock ports should go on generated icons.

Returns:
information about where Clock ports should go on generated icons. 0: left (the default) 1: right 2: top 3: bottom

setIconGenClockSide

public static void setIconGenClockSide(int side)
Method to set where Clock ports should go on generated icons.

Parameters:
side - information about where Clock ports should go on generated icons. 0: left (the default) 1: right 2: top 3: bottom

getFactoryIconGenClockSide

public static int getFactoryIconGenClockSide()
Method to tell where Clock ports should go on generated icons, by default.

Returns:
information about where Clock ports should go on generated icons, by default. 0: left 1: right 2: top 3: bottom

getIconGenExportPlacement

public static int getIconGenExportPlacement()
Method to tell how exports are placed in generated icons.

Returns:
information about how exports are placed in generated icons. 0: by characteristic 1: by location in original cell

setIconGenExportPlacement

public static void setIconGenExportPlacement(int rot)
Method to set how exports are placed in generated icons.

Parameters:
rot - information about how exports are placed in generated icons. 0: by characteristic 1: by location in original cell

getFactoryIconGenExportPlacement

public static int getFactoryIconGenExportPlacement()
Method to tell how exports are placed in generated icons, by default.

Returns:
information about how exports are placed in generated icons, by default. 0: by characteristic 1: by location in original cell

getIconGenExportPlacementExact

public static boolean getIconGenExportPlacementExact()
Method to tell whether exports are placed exactly according to schematics. Only valid if icon ports are being placed by location.

Returns:
true to place exports exactly according to schematics. false: to place exports relative to their location in the original cell.

setIconGenExportPlacementExact

public static void setIconGenExportPlacementExact(boolean flag)
Method to set whether exports are placed exactly according to schematics. Only valid if icon ports are being placed by location.

Parameters:
flag - true to place exports exactly according to schematics. false: to place exports relative to their location in the original cell.

getFactoryIconGenExportPlacementExact

public static boolean getFactoryIconGenExportPlacementExact()
Method to tell whether exports are placed exactly according to schematics, by default. Only valid if icon ports are being placed by location.

Returns:
true to place exports exactly according to schematics, by default. false: to place exports relative to their location in the original cell.

getIconGenInputRot

public static int getIconGenInputRot()
Method to tell what angle Input ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Input ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenInputRot

public static void setIconGenInputRot(int rot)
Method to set what angle Input ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Parameters:
rot - information about what angle Input ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenInputRot

public static int getFactoryIconGenInputRot()
Method to tell what angle Input ports should go on generated icons, by default. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Input ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenOutputRot

public static int getIconGenOutputRot()
Method to tell what angle Output ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Output ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenOutputRot

public static void setIconGenOutputRot(int rot)
Method to set what angle Output ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Parameters:
rot - information about what angle Output ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenOutputRot

public static int getFactoryIconGenOutputRot()
Method to tell what angle Output ports should go on generated icons, by default. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Output ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenBidirRot

public static int getIconGenBidirRot()
Method to tell what angle Bidirectional ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Bidirectional ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenBidirRot

public static void setIconGenBidirRot(int rot)
Method to set what angle Bidirectional ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Parameters:
rot - information about what angle Bidirectional ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenBidirRot

public static int getFactoryIconGenBidirRot()
Method to tell what angle Bidirectional ports should go on generated icons, by default. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Bidirectional ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenPowerRot

public static int getIconGenPowerRot()
Method to tell what angle Power ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Power ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenPowerRot

public static void setIconGenPowerRot(int rot)
Method to set what angle Power ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Parameters:
rot - information about what angle Power ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenPowerRot

public static int getFactoryIconGenPowerRot()
Method to tell what angle Power ports should go on generated icons, by default. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Power ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenGroundRot

public static int getIconGenGroundRot()
Method to tell what angle Ground ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Ground ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenGroundRot

public static void setIconGenGroundRot(int rot)
Method to set what angle Ground ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Parameters:
rot - information about what angle Ground ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenGroundRot

public static int getFactoryIconGenGroundRot()
Method to tell what angle Ground ports should go on generated icons, by default. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Ground ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenClockRot

public static int getIconGenClockRot()
Method to tell what angle Clock ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Clock ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenClockRot

public static void setIconGenClockRot(int rot)
Method to set what angle Clock ports should go on generated icons. This applies only when ports are placed by "characteristic", not "location".

Parameters:
rot - information about what angle Clock ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenClockRot

public static int getFactoryIconGenClockRot()
Method to tell what angle Clock ports should go on generated icons, by default. This applies only when ports are placed by "characteristic", not "location".

Returns:
information about what angle Clock ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenTopRot

public static int getIconGenTopRot()
Method to tell what angle Top ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Top ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenTopRot

public static void setIconGenTopRot(int rot)
Method to set what angle Top ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Parameters:
rot - information about what angle Top ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenTopRot

public static int getFactoryIconGenTopRot()
Method to tell what angle Top ports should go on generated icons, by default. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Top ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenBottomRot

public static int getIconGenBottomRot()
Method to tell what angle Bottom ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Bottom ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenBottomRot

public static void setIconGenBottomRot(int rot)
Method to set what angle Bottom ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Parameters:
rot - information about what angle Bottom ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenBottomRot

public static int getFactoryIconGenBottomRot()
Method to tell what angle Bottom ports should go on generated icons, by default. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Bottom ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenLeftRot

public static int getIconGenLeftRot()
Method to tell what angle Left ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Left ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenLeftRot

public static void setIconGenLeftRot(int rot)
Method to set what angle Left ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Parameters:
rot - information about what angle Left ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenLeftRot

public static int getFactoryIconGenLeftRot()
Method to tell what angle Left ports should go on generated icons, by default. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Left ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenRightRot

public static int getIconGenRightRot()
Method to tell what angle Right ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Right ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

setIconGenRightRot

public static void setIconGenRightRot(int rot)
Method to set what angle Right ports should go on generated icons. This applies only when ports are placed by "location", not "characteristic".

Parameters:
rot - information about what angle Right ports should go on generated icons. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getFactoryIconGenRightRot

public static int getFactoryIconGenRightRot()
Method to tell what angle Right ports should go on generated icons, by default. This applies only when ports are placed by "location", not "characteristic".

Returns:
information about what angle Right ports should go on generated icons, by default. 0: normal 1: rotate 90 degrees 2: rotate 180 degrees 3: rotate 270 degrees

getIconGenExportLocation

public static int getIconGenExportLocation()
Method to tell where exports should appear along the leads in generated icons.

Returns:
information about where exports should appear along the leads in generated icons. 0: on the body 1: (the default) at the end of the lead 2: in the middle of the lead

setIconGenExportLocation

public static void setIconGenExportLocation(int loc)
Method to set how exports should appear along the leads in generated icons.

Parameters:
loc - information about where exports should appear along the leads in generated icons. 0: on the body 1: at the end of the lead (the default) 2: in the middle of the lead

getFactoryIconGenExportLocation

public static int getFactoryIconGenExportLocation()
Method to tell where exports should appear along the leads in generated icons, by default.

Returns:
information about where exports should appear along the leads in generated icons, by default. 0: on the body 1: at the end of the lead 2: in the middle of the lead

getIconGenExportStyle

public static int getIconGenExportStyle()
Method to tell how the text should appear in generated icons.

Returns:
information about how the text should appear in generated icons. 0: (the default) centered at the export location 1: pointing inward from the export location 2: pointing outward from the export location

setIconGenExportStyle

public static void setIconGenExportStyle(int style)
Method to set how the text should appear in generated icons.

Parameters:
style - information about how the text should appear in generated icons. 0: centered at the export location 1: pointing inward from the export location 2: pointing outward from the export location

getFactoryIconGenExportStyle

public static int getFactoryIconGenExportStyle()
Method to tell how the text should appear in generated icons, by default.

Returns:
information about how the text should appear in generated icons, by default. 0: centered at the export location 1: pointing inward from the export location 2: pointing outward from the export location

getIconGenExportTech

public static int getIconGenExportTech()
Method to tell how exports should be constructed in generated icons.

Returns:
information about how exports should be constructed in generated icons. 0: use Generic:Universal-Pins for non-bus exports (can connect to ANYTHING). 1: (the default) use Schematic:Bus-Pins for exports (can connect to schematic busses or wires).

setIconGenExportTech

public static void setIconGenExportTech(int t)
Method to set how exports should be constructed in generated icons.

Parameters:
t - information about how exports should be constructed in generated icons. 0: use Generic:Universal-Pins for non-bus exports (can connect to ANYTHING). 1: use Schematic:Bus-Pins for exports (can connect to schematic busses or wires).

getFactoryIconGenExportTech

public static int getFactoryIconGenExportTech()
Method to tell how exports should be constructed in generated icons, by default.

Returns:
information about how exports should be constructed in generated icons, by default. 0: use Generic:Universal-Pins for non-bus exports (can connect to ANYTHING). 1: use Schematic:Bus-Pins for exports (can connect to schematic busses or wires).

getIconGenInstanceLocation

public static int getIconGenInstanceLocation()
Method to tell where to place an instance of the generated icons in the original schematic.

Returns:
information about where to place an instance of the generated icons in the original schematic 0: (the default) in the upper-right corner. 1: in the upper-left corner. 2: in the lower-right corner. 3: in the lower-left corner. 4: no instance in the original schematic

setIconGenInstanceLocation

public static void setIconGenInstanceLocation(int loc)
Method to set where to place an instance of the generated icons in the original schematic.

Parameters:
loc - information about where to place an instance of the generated icons in the original schematic. 0: in the upper-right corner. 1: in the upper-left corner. 2: in the lower-right corner. 3: in the lower-left corner. 4: no instance in the original schematic

getFactoryIconGenInstanceLocation

public static int getFactoryIconGenInstanceLocation()
Method to tell where to place an instance of the generated icons in the original schematic, by default.

Returns:
information about where to place an instance of the generated icons in the original schematic, by default. 0: in the upper-right corner. 1: in the upper-left corner. 2: in the lower-right corner. 3: in the lower-left corner. 4: no instance in the original schematic

getIconGenLeadLength

public static double getIconGenLeadLength()
Method to tell how long to make leads in generated icons.

Returns:
information about how long to make leads in generated icons (the default is 2).

setIconGenLeadLength

public static void setIconGenLeadLength(double len)
Method to set how long to make leads in generated icons.

Parameters:
len - how long to make leads in generated icons.

getFactoryIconGenLeadLength

public static double getFactoryIconGenLeadLength()
Method to tell how long to make leads in generated icons, by default.

Returns:
information about how long to make leads in generated icons, by default.

getIconGenLeadSpacing

public static double getIconGenLeadSpacing()
Method to tell how far apart to space leads in generated icons.

Returns:
information about how far apart to space leads in generated icons (the default is 2).

setIconGenLeadSpacing

public static void setIconGenLeadSpacing(double dist)
Method to set how far apart to space leads in generated icons.

Parameters:
dist - how far apart to space leads in generated icons.

getFactoryIconGenLeadSpacing

public static double getFactoryIconGenLeadSpacing()
Method to tell how far apart to space leads in generated icons, by default.

Returns:
information about how far apart to space leads in generated icons, by default.

getPortDisplayLevel

public static int getPortDisplayLevel()
Method to tell how to display ports.

Returns:
how to display ports. 0: full port names (the default). 1: short port names (stopping at the first nonalphabetic character). 2: ports drawn as crosses.

getExportDisplayLevel

public static int getExportDisplayLevel()
Method to tell how to display exports.

Returns:
how to display exports. 0: full export names (the default). 1: short export names (stopping at the first nonalphabetic character). 2: exports drawn as crosses.

isMoveNodeWithExport

public static boolean isMoveNodeWithExport()
Method to tell whether to move a node when its export name moves. The default is "false", which means that the export text can move independently.

Returns:
true to move a node when its export name moves.

setMoveNodeWithExport

public static void setMoveNodeWithExport(boolean on)
Method to set whether to move a node when its export name moves.

Parameters:
on - true to move a node when its export name moves.

isFactoryMoveNodeWithExport

public static boolean isFactoryMoveNodeWithExport()
Method to tell whether to move a node when its export name moves, by default.

Returns:
true to move a node when its export name moves, by default.

isEasySelectionOfCellInstances

public static boolean isEasySelectionOfCellInstances()
Method to tell whether cell instances are all be easy-to-select. The default is "true".

Returns:
true if cell instances are all be easy-to-select.

setEasySelectionOfCellInstances

public static void setEasySelectionOfCellInstances(boolean on)
Method to set whether cell instances are all be easy-to-select.

Parameters:
on - true if cell instances are all to be easy-to-select.

isFactoryEasySelectionOfCellInstances

public static boolean isFactoryEasySelectionOfCellInstances()
Method to tell whether cell instances are all be easy-to-select by default.

Returns:
true if cell instances are all be easy-to-select by default.

isDraggingMustEncloseObjects

public static boolean isDraggingMustEncloseObjects()
Method to tell whether dragging a selection rectangle must completely encose objects in order to select them. The default is "false", which means that the selection rectangle need only touch an object in order to select it.

Returns:
true if dragging a selection rectangle must completely encose objects in order to select them.

setDraggingMustEncloseObjects

public static void setDraggingMustEncloseObjects(boolean on)
Method to set whether dragging a selection rectangle must completely encose objects in order to select them.

Parameters:
on - true if dragging a selection rectangle must completely encose objects in order to select them.

isFactoryDraggingMustEncloseObjects

public static boolean isFactoryDraggingMustEncloseObjects()
Method to tell whether dragging a selection rectangle must completely encose objects in order to select them, by default.

Returns:
true if dragging a selection rectangle must completely encose objects in order to select them, by default.

isMouseOverHighlightingEnabled

public static boolean isMouseOverHighlightingEnabled()
Method to tell whether dragging a selection rectangle must completely encose objects in order to select them. The default is "false", which means that the selection rectangle need only touch an object in order to select it.

Returns:
true if dragging a selection rectangle must completely encose objects in order to select them.

setMouseOverHighlightingEnabled

public static void setMouseOverHighlightingEnabled(boolean on)
Method to set whether dragging a selection rectangle must completely encose objects in order to select them.

Parameters:
on - true if dragging a selection rectangle must completely encose objects in order to select them.

isFactoryMouseOverHighlightingEnabled

public static boolean isFactoryMouseOverHighlightingEnabled()
Method to tell whether dragging a selection rectangle must completely encose objects in order to select them, by default.

Returns:
true if dragging a selection rectangle must completely encose objects in order to select them, by default.

isHighlightConnectedObjects

public static boolean isHighlightConnectedObjects()
Method to set whether to highlight objects connected to the selected object

Returns:
true to highlight objects connected to the selected object, false otherwise

setHighlightConnectedObjects

public static void setHighlightConnectedObjects(boolean on)
Method to get whether to highlight objects connected to the selected object

Parameters:
on - true to highlight objects connected to the selected object

isFactoryHighlightConnectedObjects

public static boolean isFactoryHighlightConnectedObjects()
Method to set whether to highlight objects connected to the selected object, by default.

Returns:
true to highlight objects connected to the selected object by default, false otherwise

isHighlightInvisibleObjects

public static boolean isHighlightInvisibleObjects()
Method to set whether to highlight objects whose layers are all invisible.

Returns:
true to highlight objects whose layers are all invisible.

setHighlightInvisibleObjects

public static void setHighlightInvisibleObjects(boolean on)
Method to get whether to highlight objects whose layers are all invisible.

Parameters:
on - true to highlight objects whose layers are all invisible.

isFactoryHighlightInvisibleObjects

public static boolean isFactoryHighlightInvisibleObjects()
Method to set whether to highlight objects whose layers are all invisible, by default.

Returns:
true to highlight objects whose layers are all invisible by default.

getDefGridXSpacing

public static double getDefGridXSpacing()
Method to return the default spacing of grid dots in the X direction. The default is 1.

Returns:
the default spacing of grid dots in the X direction.

setDefGridXSpacing

public static void setDefGridXSpacing(double dist)
Method to set the default spacing of grid dots in the X direction.

Parameters:
dist - the default spacing of grid dots in the X direction.

getFactoryDefGridXSpacing

public static double getFactoryDefGridXSpacing()
Method to return the default spacing of grid dots in the X direction (factory setting).

Returns:
the default spacing of grid dots in the X direction (factory setting).

getDefGridYSpacing

public static double getDefGridYSpacing()
Method to return the default spacing of grid dots in the Y direction. The default is 1.

Returns:
the default spacing of grid dots in the Y direction.

setDefGridYSpacing

public static void setDefGridYSpacing(double dist)
Method to set the default spacing of grid dots in the Y direction.

Parameters:
dist - the default spacing of grid dots in the Y direction.

getFactoryDefGridYSpacing

public static double getFactoryDefGridYSpacing()
Method to return the default spacing of grid dots in the Y direction (factory setting).

Returns:
the default spacing of grid dots in the Y direction (factory setting).

getDefGridXBoldFrequency

public static int getDefGridXBoldFrequency()
Method to return the default frequency of bold grid dots in the X direction. The default is 10.

Returns:
the default frequency of bold grid dots in the X direction.

setDefGridXBoldFrequency

public static void setDefGridXBoldFrequency(int dist)
Method to set the default frequency of bold grid dots in the X direction.

Parameters:
dist - the default frequency of bold grid dots in the X direction.

getFactoryDefGridXBoldFrequency

public static int getFactoryDefGridXBoldFrequency()
Method to return the default frequency of bold grid dots in the X direction (factory setting).

Returns:
the default frequency of bold grid dots in the X direction (factory setting).

getDefGridYBoldFrequency

public static int getDefGridYBoldFrequency()
Method to return the default frequency of bold grid dots in the Y direction. The default is 10.

Returns:
the default frequency of bold grid dots in the Y direction.

setDefGridYBoldFrequency

public static void setDefGridYBoldFrequency(int dist)
Method to set the default frequency of bold grid dots in the Y direction.

Parameters:
dist - the default frequency of bold grid dots in the Y direction.

getFactoryDefGridYBoldFrequency

public static int getFactoryDefGridYBoldFrequency()
Method to return the default frequency of bold grid dots in the Y direction (factory setting).

Returns:
the default frequency of bold grid dots in the Y direction (factory setting).

getAlignmentToGrid

public static Dimension2D getAlignmentToGrid()
Method to return the default alignment of objects to the grid. The default is (1,1), meaning that placement and movement should land on whole grid units.

Returns:
the default alignment of objects to the grid.

getAlignmentToGridIndex

public static int getAlignmentToGridIndex()
Method to return index of the current alignment.

Returns:
the index of the current alignment.

getAlignmentToGridVector

public static Dimension2D[] getAlignmentToGridVector()
Method to return an array of five grid alignment values.

Returns:
an array of five grid alignment values.

setAlignmentToGridVector

public static void setAlignmentToGridVector(Dimension2D[] dist,
                                            int current)
Method to set the default alignment of objects to the grid.

Parameters:
dist - the array of grid alignment values.
current - the index in the array that is the current grid alignment.

isGridAxesShown

public static boolean isGridAxesShown()
Method to return true if grid axes are shown. Grid axes are solid lines passing through the origin. The default is false.

Returns:
true if grid axes are shown.

setGridAxesShown

public static void setGridAxesShown(boolean s)
Method to set if grid axes are shown. Grid axes are solid lines passing through the origin.

Parameters:
s - true if grid axes are shown.

isFactoryGridAxesShown

public static boolean isFactoryGridAxesShown()
Method to return true if grid axes are shown, by default. Grid axes are solid lines passing through the origin.

Returns:
true if grid axes are shown, by default.

isTextVisibilityOn

public static boolean isTextVisibilityOn(AbstractTextDescriptor.TextType textType)
Method to tell whether to draw text of particular text type. The default is "true".

Parameters:
textType - specified text type
Returns:
true if the system should text of specified type.

isTextVisibilityOnNode

public static boolean isTextVisibilityOnNode()
Method to tell whether to draw text that resides on nodes. This text includes the node name and any parameters or attributes on it. The default is "true".

Returns:
true if the system should draw text that resides on nodes.

isTextVisibilityOnArc

public static boolean isTextVisibilityOnArc()
Method to tell whether to draw text that resides on arcs. This text includes the arc name and any parameters or attributes on it. The default is "true".

Returns:
true if the system should draw text that resides on arcs.

isTextVisibilityOnPort

public static boolean isTextVisibilityOnPort()
Method to tell whether to draw text that resides on ports. This text includes the port name and any parameters or attributes on it. The default is "true".

Returns:
true if the system should draw text that resides on ports.

isTextVisibilityOnExport

public static boolean isTextVisibilityOnExport()
Method to tell whether to draw text that resides on exports. This text includes the export name and any parameters or attributes on it. The default is "true".

Returns:
true if the system should draw text that resides on exports.

isTextVisibilityOnAnnotation

public static boolean isTextVisibilityOnAnnotation()
Method to tell whether to draw text annotation text. Annotation text is not attached to any node or arc, but appears to move freely about the cell. In implementation, they are displayable Variables on Generic:invisible-pin nodes. The default is "true".

Returns:
true if the system should draw annotation text.

isTextVisibilityOnInstance

public static boolean isTextVisibilityOnInstance()
Method to tell whether to draw the name of on cell instances. The default is "true".

Returns:
true if the system should draw the name of on cell instances.

isTextVisibilityOnCell

public static boolean isTextVisibilityOnCell()
Method to tell whether to draw text that resides on the cell. This includes the current cell's parameters or attributes (for example, spice templates). The default is "true".

Returns:
true if the system should draw text that resides on the cell.

getDefaultFont

public static java.lang.String getDefaultFont()
Method to get the default font to use on the display. The default is "SansSerif".

Returns:
the default font to use on the display.

getFactoryDefaultFont

public static java.lang.String getFactoryDefaultFont()
Method to get the factory default font to use on the display.

Returns:
the factory default font to use on the display.

getDefaultTextCellFont

public static java.lang.String getDefaultTextCellFont()
Method to get the default font to use when editing textual cells. The default is "SansSerif".

Returns:
the default font to use when editing textual cells.

setDefaultTextCellFont

public static void setDefaultTextCellFont(java.lang.String f)
Method to set the default font to use when editing textual cells.

Parameters:
f - the default font to use when editing textual cells.

getFactoryDefaultTextCellFont

public static java.lang.String getFactoryDefaultTextCellFont()
Method to get the factory default font to use when editing textual cells.

Returns:
the factory default font to use when editing textual cells.

getDefaultTextCellSize

public static int getDefaultTextCellSize()
Method to tell the size of text in textual cells. The default is "12".

Returns:
the size of text in textual cells.

setDefaultTextCellSize

public static void setDefaultTextCellSize(int s)
Method to set the size of text in textual cells.

Parameters:
s - the size of text in textual cells.

getFactoryDefaultTextCellSize

public static int getFactoryDefaultTextCellSize()
Method to tell the size of text in textual cells, by default.

Returns:
the size of text in textual cells, by default.

getGlobalTextScale

public static double getGlobalTextScale()
Method to tell the default global text scale factor. This factor is the initial text scaling factor for new windows and enlarges or reduces all displayed text. The default is "1".

Returns:
the default global text scale factor.

setGlobalTextScale

public static void setGlobalTextScale(double s)
Method to set the default global text scale factor. This factor is the initial text scaling factor for new windows and enlarges or reduces all displayed text.

Parameters:
s - the default global text scale.

getFactoryGlobalTextScale

public static double getFactoryGlobalTextScale()
Method to tell the factory default global text scale factor. This factor is the initial text scaling factor for new windows and enlarges or reduces all displayed text.

Returns:
the factory default global text scale factor.

getDefaultTextExternalEditor

public static java.lang.String getDefaultTextExternalEditor()
Method to get the program to invoke when externally editing textual cells. The default is blank.

Returns:
the program to invoke when externally editing textual cells.

setDefaultTextExternalEditor

public static void setDefaultTextExternalEditor(java.lang.String e)
Method to set the program to invoke when externally editing textual cells.

Parameters:
e - the program to invoke when externally editing textual cells.

getFactoryDefaultTextExternalEditor

public static java.lang.String getFactoryDefaultTextExternalEditor()
Method to get the program to invoke when externally editing textual cells, by default.

Returns:
the program to invoke when externally editing textual cells, by default.

getFrameCompanyName

public static java.lang.String getFrameCompanyName()
Method to return the company name to use in schematic frames. The company information sits in a block in the lower-right corner. The default is "".

Returns:
the company name to use in schematic frames.

setFrameCompanyName

public static void setFrameCompanyName(java.lang.String c)
Method to set the company name to use in schematic frames. The company information sits in a block in the lower-right corner.

Parameters:
c - the company name to use in schematic frames.

getFactoryFrameCompanyName

public static java.lang.String getFactoryFrameCompanyName()
Method to return the company name to use in schematic frames, by default. The company information sits in a block in the lower-right corner.

Returns:
the company name to use in schematic frames, by default.

getFrameDesignerName

public static java.lang.String getFrameDesignerName()
Method to return the designer name to use in schematic frames. The designer information sits in a block in the lower-right corner. The default is "".

Returns:
the designer name to use in schematic frames.

setFrameDesignerName

public static void setFrameDesignerName(java.lang.String c)
Method to set the designer name to use in schematic frames. The designer information sits in a block in the lower-right corner.

Parameters:
c - the designer name to use in schematic frames.

getFactoryFrameDesignerName

public static java.lang.String getFactoryFrameDesignerName()
Method to return the designer name to use in schematic frames, by default. The designer information sits in a block in the lower-right corner.

Returns:
the designer name to use in schematic frames, by default.

getFrameProjectName

public static java.lang.String getFrameProjectName()
Method to return the project name to use in schematic frames. The project information sits in a block in the lower-right corner. The default is "".

Returns:
the project name to use in schematic frames.

setFrameProjectName

public static void setFrameProjectName(java.lang.String c)
Method to set the project name to use in schematic frames. The project information sits in a block in the lower-right corner.

Parameters:
c - the project name to use in schematic frames.

getFactoryFrameProjectName

public static java.lang.String getFactoryFrameProjectName()
Method to return the project name to use in schematic frames, by default. The project information sits in a block in the lower-right corner.

Returns:
the project name to use in schematic frames, by default.

getColor

public static int getColor(User.ColorPrefType pref)
Method to get the color of a given special layer on the display. BACKGROUND: color of the background on the display. The default is "light gray". GRID: color of the grid on the display. The default is "black". HIGHLIGHT: color of the highlight on the display. The default is "white". MOUSEOVER_HIGHLIGHT: color of the highlight on the display. The default is "white". PORT_HIGHLIGHT: color of the port highlight on the display. The default is "yellow". TEXT: color of the text on the display. The default is "black". INSTANCE: color of the instance outlines on the display. The default is "black". ARTWORK: default color of the artwork primitives on the display. The default is "black". DOWNINPLACEBORDER: color of the border around cells drawn "down in place". The default is "red". WAVE_BACKGROUND: color of the waveform window background. The default is "black". WAVE_FOREGROUND: color of the waveform window foreground. This includes lines and text. The default is "white". WAVE_STIMULI: color of the traces in waveform windows. Applies only when not a "multistate" display, which uses many colors. The default is "red". WAVE_OFF_STRENGTH: color of waveform window traces that have "off" strength. The default is "blue". WAVE_NODE_STRENGTH: color of waveform window traces that have "node" strength. The default is "green". WAVE_GATE_STRENGTH: color of waveform window traces that have "gate" strength. The default is "magenta". WAVE_POWER_STRENGTH: color of waveform window traces that have "power" strength. The default is "light gray". WAVE_CROSS_LOW: color of cross-probe traces from the waveform window that are "low". These are lines drawn on the schematic or layout to correspond with the value in the waveform window. The default is "blue". WAVE_CROSS_HIGH: color of cross-probe traces from the waveform window that are "high". These are lines drawn on the schematic or layout to correspond with the value in the waveform window. The default is "green". WAVE_CROSS_UNDEF: color of cross-probe traces from the waveform window that are "undefined". These are lines drawn on the schematic or layout to correspond with the value in the waveform window. The default is "black". WAVE_CROSS_FLOAT: color of cross-probe traces from the waveform window that are "floating". These are lines drawn on the schematic or layout to correspond with the value in the waveform window. The default is "light gray".

Parameters:
pref - special layer in question
Returns:
color of the special layer

setColor

public static void setColor(User.ColorPrefType pref,
                            int color)
Method to set the color of a given special layer BACKGROUND: color of the background on the display. GRID: color of the grid on the display. HIGHLIGHT: color of the highlight on the display. MOUSEOVER_HIGHLIGHT: color of the highlight on the display. PORT_HIGHLIGHT: color of the port highlight on the display. TEXT: color of the text on the display. INSTANCE: color of the instance outlines on the display. DOWNINPLACEBORDER: color of the border around cells drawn "down in place". The default is "red". WAVE_BACKGROUND: color of the waveform window background. WAVE_FOREGROUND: color of the waveform window foreground. This includes lines and text. WAVE_STIMULI: color of the traces in waveform windows. Applies only when not a "multistate" display, which uses many colors. WAVE_OFF_STRENGTH: color of waveform window traces that have "off" strength. WAVE_NODE_STRENGTH: color of waveform window traces that have "node" strength. WAVE_GATE_STRENGTH: color of waveform window traces that have "gate" strength. WAVE_POWER_STRENGTH: color of waveform window traces that have "power" strength. WAVE_CROSS_LOW: color of cross-probe traces from the waveform window that are "low". These are lines drawn on the schematic or layout to correspond with the value in the waveform window. WAVE_CROSS_HIGH: color of cross-probe traces from the waveform window that are "high". These are lines drawn on the schematic or layout to correspond with the value in the waveform window. WAVE_CROSS_UNDEF: color of cross-probe traces from the waveform window that are "undefined". These are lines drawn on the schematic or layout to correspond with the value in the waveform window. WAVE_CROSS_FLOAT: color of cross-probe traces from the waveform window that are "floating". These are lines drawn on the schematic or layout to correspond with the value in the waveform window.

Parameters:
pref -
color -

resetFactoryColor

public static void resetFactoryColor(User.ColorPrefType pref)
Method to reset to the factory color of a given special layer BACKGROUND: The default is "light gray". GRID: The default is "black". HIGHLIGHT: The default is "white". MOUSEOVER_HIGHLIGHT: The default is "white". PORT_HIGHLIGHT: The default is "yellow". TEXT: The default is "black". INSTANCE: The default is "black". DOWNINPLACEBORDER: The default is "red". WAVE_BACKGROUND: The default is "black". WAVE_FOREGROUND: The default is "white". WAVE_STIMULI: The default is "red". WAVE_OFF_STRENGTH: The default is "blue". WAVE_NODE_STRENGTH: The default is "green". WAVE_GATE_STRENGTH: The default is "magenta". WAVE_POWER_STRENGTH: The default is "light gray". WAVE_CROSS_LOW: The default is "blue". WAVE_CROSS_HIGH: The default is "green". WAVE_CROSS_UNDEF: The default is "black". WAVE_CROSS_FLOAT: The default is "light gray".

Parameters:
pref -

getDistanceUnits

public static TextUtils.UnitScale getDistanceUnits()
Method to get current distance units. The default is "scalable units".

Returns:
the current distance units. Returns null to use scalable units.

setDistanceUnits

public static void setDistanceUnits(TextUtils.UnitScale us)
Method to set the current distance units.

Parameters:
us - the current distance units (null to use scalable units).

getFactoryDistanceUnits

public static TextUtils.UnitScale getFactoryDistanceUnits()
Method to get default distance units.

Returns:
the default distance units. Returns null to use scalable units.

getResistanceUnits

public static TextUtils.UnitScale getResistanceUnits()
Method to get current resistance units. The default is "ohms".

Returns:
the current resistance units.

setResistanceUnits

public static void setResistanceUnits(TextUtils.UnitScale us)
Method to set the current resistance units.

Parameters:
us - the current resistance units.

getFactoryResistanceUnits

public static TextUtils.UnitScale getFactoryResistanceUnits()
Method to get default resistance units.

Returns:
the default resistance units.

getCapacitanceUnits

public static TextUtils.UnitScale getCapacitanceUnits()
Method to get current capacitance units. The default is "picofarads".

Returns:
the current capacitance units.

setCapacitanceUnits

public static void setCapacitanceUnits(TextUtils.UnitScale us)
Method to set the current capacitance units.

Parameters:
us - the current capacitance units.

getFactoryCapacitanceUnits

public static TextUtils.UnitScale getFactoryCapacitanceUnits()
Method to get default capacitance units.

Returns:
the default capacitance units.

getInductanceUnits

public static TextUtils.UnitScale getInductanceUnits()
Method to get current inductance units. The default is "nanohenrys".

Returns:
the current inductance units.

setInductanceUnits

public static void setInductanceUnits(TextUtils.UnitScale us)
Method to set the current inductance units.

Parameters:
us - the current inductance units.

getFactoryInductanceUnits

public static TextUtils.UnitScale getFactoryInductanceUnits()
Method to get default inductance units.

Returns:
the default inductance units.

getAmperageUnits

public static TextUtils.UnitScale getAmperageUnits()
Method to get current amperage (current) units. The default is "milliamps".

Returns:
the current amperage (current) units.

setAmperageUnits

public static void setAmperageUnits(TextUtils.UnitScale us)
Method to set the current amperage (current) units.

Parameters:
us - the current amperage (current) units.

getFactoryAmperageUnits

public static TextUtils.UnitScale getFactoryAmperageUnits()
Method to get default amperage (current) units.

Returns:
the default amperage (current) units.

getVoltageUnits

public static TextUtils.UnitScale getVoltageUnits()
Method to get current voltage units. The default is "volts".

Returns:
the current voltage) units.

setVoltageUnits

public static void setVoltageUnits(TextUtils.UnitScale us)
Method to set the current voltage units.

Parameters:
us - the current voltage units.

getFactoryVoltageUnits

public static TextUtils.UnitScale getFactoryVoltageUnits()
Method to get default voltage units.

Returns:
the default voltage) units.

getTimeUnits

public static TextUtils.UnitScale getTimeUnits()
Method to get current time units. The default is "seconds".

Returns:
the current time units.

setTimeUnits

public static void setTimeUnits(TextUtils.UnitScale us)
Method to set the current time units.

Parameters:
us - the current time units.

getFactoryTimeUnits

public static TextUtils.UnitScale getFactoryTimeUnits()
Method to get default time units.

Returns:
the default time units.

getWorkingDirectory

public static java.lang.String getWorkingDirectory()
Method to get the path of the current working directory. The default is the Java "user directory".

Returns:
the path of the current working directory.

setWorkingDirectory

public static void setWorkingDirectory(java.lang.String dir)
Method to set the path of the current working directory.

Parameters:
dir - the path of the current working directory.

getRegressionPath

public static java.lang.String getRegressionPath()
Method to get the path of the regression tests directory. The default is a String with invalid path.

Returns:
the path of the regression tests directory.

setRegressionPath

public static void setRegressionPath(java.lang.String s)
Method to set the path of the regression tests directory.

Parameters:
s - the path of the regression tests directory.

getRecentlyOpenedLibraries

public static java.lang.String[] getRecentlyOpenedLibraries()
Get an array of File paths to recently opened libraries. These should be libraries the user opened, and not contain reference libraries opened as a result of a user opening a library.

Returns:
a list of file paths to libraries (without extension - no delib or jelib)

addRecentlyOpenedLibrary

public static void addRecentlyOpenedLibrary(java.lang.String s)
Add a file path (no extension) to a list of recently opened libraries. This should not include reference libraries opened as a side-affect of opening a library.

Parameters:
s - the file path to a library

clearRecentlyOpenedLibraries

public static void clearRecentlyOpenedLibraries()
Clear the list of recently opened libraries.


isPromptForIndexWhenDescending

public static boolean isPromptForIndexWhenDescending()
Method to tell whether to prompt the user for an array index when descending into arrayed nodes. When descending into arrayed nodes, the context doesn't know which index is being traversed. If a simulation window is present, the user is prompted, because the specific index is important. When Logical Effort information is available, prompting is also necessary. The default is "false" (do not prompt if other indicators are not present).

Returns:
true to prompt the user for an array index when descending into arrayed nodes.

setPromptForIndexWhenDescending

public static void setPromptForIndexWhenDescending(boolean on)
Method to set whether to prompt the user for an array index when descending into arrayed nodes. When descending into arrayed nodes, the context doesn't know which index is being traversed. If a simulation window is present, the user is prompted, because the specific index is important. When Logical Effort information is available, prompting is also necessary.

Parameters:
on - true to prompt the user for an array index when descending into arrayed nodes.

isFactoryPromptForIndexWhenDescending

public static boolean isFactoryPromptForIndexWhenDescending()
Method to tell whether to prompt the user for an array index when descending into arrayed nodes, by default. When descending into arrayed nodes, the context doesn't know which index is being traversed. If a simulation window is present, the user is prompted, because the specific index is important. When Logical Effort information is available, prompting is also necessary.

Returns:
true to prompt the user for an array index when descending into arrayed nodes by default.

isBeepAfterLongJobs

public static boolean isBeepAfterLongJobs()
Method to tell whether to beep after long jobs. Any task longer than 1 minute is considered a "long job". The default is "false".

Returns:
true if the system should beep after long jobs.

setBeepAfterLongJobs

public static void setBeepAfterLongJobs(boolean on)
Method to set whether to beep after long jobs. Any task longer than 1 minute is considered a "long job".

Parameters:
on - true if the system should beep after long jobs.

isFactoryBeepAfterLongJobs

public static boolean isFactoryBeepAfterLongJobs()
Method to tell whether to beep after long jobs, by default. Any task longer than 1 minute is considered a "long job".

Returns:
true if the system should beep after long jobs, by default.

isJobVerboseMode

public static boolean isJobVerboseMode()
Method to tell if jobs are described in messages window (verbose mode) The default is "false".

Returns:
true if jobs are described in the messages window.

setJobVerboseMode

public static void setJobVerboseMode(boolean on)
Method to set whether jobs are described in messages window.

Parameters:
on - true if jobs are described in the messages window.

isFactoryJobVerboseMode

public static boolean isFactoryJobVerboseMode()
Method to tell if jobs are described in messages window (verbose mode), by default.

Returns:
true if jobs are described in the messages window, by default.

isRotateLayoutTransistors

public static boolean isRotateLayoutTransistors()
Method to tell if layout transistors are rotated 90 degrees in the menu (and initial placement). The default is "false".

Returns:
true if layout transistors are rotated 90 degrees in the menu (and initial placement).

setRotateLayoutTransistors

public static void setRotateLayoutTransistors(boolean on)
Method to set whether layout transistors are rotated 90 degrees in the menu (and initial placement).

Parameters:
on - true if layout transistors are rotated 90 degrees in the menu (and initial placement).

isFactoryRotateLayoutTransistors

public static boolean isFactoryRotateLayoutTransistors()
Method to tell if layout transistors are rotated 90 degrees in the menu (and initial placement), by default.

Returns:
true if layout transistors are rotated 90 degrees in the menu (and initial placement), by default.

isSideBarOnRight

public static boolean isSideBarOnRight()
Method to tell whether to place the side bar on the right by default. The side bar (with the cell explorer, component menu, and layers) is usually on the left side. The default is "false" (place on left).

Returns:
true to place the side bar on the right by default.

setSideBarOnRight

public static void setSideBarOnRight(boolean on)
Method to set whether to place the side bar on the right by default. The side bar (with the cell explorer, component menu, and layers) is usually on the left side.

Parameters:
on - true to place the side bar on the right by default.

isFactorySideBarOnRight

public static boolean isFactorySideBarOnRight()
Method to tell whether to place the side bar on the right by default (factory setting). The side bar (with the cell explorer, component menu, and layers) is usually on the left side.

Returns:
true to place the side bar on the right by default (factory setting).

getDefaultWindowTab

public static int getDefaultWindowTab()
Method to tell the default tab to show. Choices are: 0=components 1=explorer 2=layers. The default is "0" (components).

Returns:
the default tab to show.

setDefaultWindowTab

public static void setDefaultWindowTab(int t)
Method to set the default tab to show. Choices are: 0=components 1=explorer 2=layers.

Parameters:
t - the default tab to show.

getDefaultWindowPos

public static java.awt.Point getDefaultWindowPos()
Method to tell the default position of top-level windows. The default is "0,0" (top-left).

Returns:
the default position of top-level windows.

setDefaultWindowPos

public static void setDefaultWindowPos(java.awt.Point pt)
Method to set the default position of top-level windows.

Parameters:
pt - the default position of top-level windows.

getDefaultWindowSize

public static java.awt.Dimension getDefaultWindowSize()
Method to tell the default size of top-level windows. The default is null (use screen default).

Returns:
the default position of top-level windows.

setDefaultWindowSize

public static void setDefaultWindowSize(java.awt.Dimension sz)
Method to set the default size of top-level windows.

Parameters:
sz - the default size of top-level windows.

getDefaultMessagesPos

public static java.awt.Point getDefaultMessagesPos()
Method to tell the default position of the messages window. The default is null (use appropriate size for screen).

Returns:
the default position of the messages window.

setDefaultMessagesPos

public static void setDefaultMessagesPos(java.awt.Point pt)
Method to set the default position of the messages window.

Parameters:
pt - the default position of the messages window.

getDefaultMessagesSize

public static java.awt.Dimension getDefaultMessagesSize()
Method to tell the default size of the messages window. The default is null (use screen default).

Returns:
the default position of the messages window.

setDefaultMessagesSize

public static void setDefaultMessagesSize(java.awt.Dimension sz)
Method to set the default size of the messages window.

Parameters:
sz - the default size of the messages window.

isPlayClickSoundsWhenCreatingArcs

public static boolean isPlayClickSoundsWhenCreatingArcs()
Method to tell whether to play a "click" sound when an arc is created. The default is "true".

Returns:
true if the system should play a "click" sound when an arc is created

setPlayClickSoundsWhenCreatingArcs

public static void setPlayClickSoundsWhenCreatingArcs(boolean on)
Method to set whether to play a "click" sound when an arc is created

Parameters:
on - true if the system should play a "click" sound when an arc is created

isFactoryPlayClickSoundsWhenCreatingArcs

public static boolean isFactoryPlayClickSoundsWhenCreatingArcs()
Method to tell whether to play a "click" sound when an arc is created, by default.

Returns:
true if the system should play a "click" sound when an arc is created, by default.

isShowHierarchicalCursorCoordinates

public static boolean isShowHierarchicalCursorCoordinates()
Method to tell whether to show hierarchical cursor coordinates as they move in the edit window. Hierarchical coordinates are those in higher-levels of the hierarchy. They are only displayed when the user has done a "Down Hierarchy" to descend the hierarchy. The coordinates are displayed from the topmost Cell that the user visited. The default is "true".

Returns:
true to show hierarchical cursor coordinates as they move in the edit window.

setShowHierarchicalCursorCoordinates

public static void setShowHierarchicalCursorCoordinates(boolean on)
Method to set whether to show hierarchical cursor coordinates as they move in the edit window. Hierarchical coordinates are those in higher-levels of the hierarchy. They are only displayed when the user has done a "Down Hierarchy" to descend the hierarchy. The coordinates are displayed from the topmost Cell that the user visited.

Parameters:
on - true to show hierarchical cursor coordinates as they move in the edit window.

isFactoryShowHierarchicalCursorCoordinates

public static boolean isFactoryShowHierarchicalCursorCoordinates()
Method to tell whether to show hierarchical cursor coordinates as they move in the edit window, by default. Hierarchical coordinates are those in higher-levels of the hierarchy. They are only displayed when the user has done a "Down Hierarchy" to descend the hierarchy. The coordinates are displayed from the topmost Cell that the user visited.

Returns:
true to show hierarchical cursor coordinates as they move in the edit window, by default.

isDimUpperLevelWhenDownInPlace

public static boolean isDimUpperLevelWhenDownInPlace()
Method to tell whether to dim the upper levels of the display when editing down-in-place. When editing down-in-place, the upper levels are not editable and are dimmed. This dimming causes slowdown on some systems and so it can be disabled. The default is "true".

Returns:
true to dim the upper levels of the display when editing down-in-place.

setDimUpperLevelWhenDownInPlace

public static void setDimUpperLevelWhenDownInPlace(boolean dim)
Method to set whether to dim the upper levels of the display when editing down-in-place. When editing down-in-place, the upper levels are not editable and are dimmed. This dimming causes slowdown on some systems and so it can be disabled.

Parameters:
dim - true to dim the upper levels of the display when editing down-in-place.

isFactoryDimUpperLevelWhenDownInPlace

public static boolean isFactoryDimUpperLevelWhenDownInPlace()
Method to tell whether to dim the upper levels of the display when editing down-in-place, by default. When editing down-in-place, the upper levels are not editable and are dimmed. This dimming causes slowdown on some systems and so it can be disabled.

Returns:
true to dim the upper levels of the display when editing down-in-place, by default.

getDisplayAlgorithm

public static int getDisplayAlgorithm()
Method to tell which display algorithm to use. The default is "1" (vector display algorithm).

Returns:
0 for the pixel display algorithm (oldest); 1 for the vector display algorithm (old); 2 for the layer display algorithm (new).

setDisplayAlgorithm

public static void setDisplayAlgorithm(int w)
Method to set the display algorithm to use.

Parameters:
w - 0 for the pixel display algorithm (oldest); 1 for the vector display algorithm (old); 2 for the layer display algorithm (new).

getFactoryDisplayAlgorithm

public static int getFactoryDisplayAlgorithm()
Method to tell which display algorithm to use, by default.

Returns:
0 for the pixel display algorithm (oldest); 1 for the vector display algorithm (old); 2 for the layer display algorithm (new).

isUseCellGreekingImages

public static boolean isUseCellGreekingImages()
Method to tell whether to use small images when greeking cells. When not using images, then a single blended color is used for greeked cells. The default is "false".

Returns:
true to use small images when greeking cells.

setUseCellGreekingImages

public static void setUseCellGreekingImages(boolean on)
Method to set whether to use small images when greeking cells. When not using images, then a single blended color is used for greeked cells.

Parameters:
on - true to use small images when greeking cells.

isFactoryUseCellGreekingImages

public static boolean isFactoryUseCellGreekingImages()
Method to tell whether to use small images when greeking cells, by default. When not using images, then a single blended color is used for greeked cells.

Returns:
true to use small images when greeking cells, by default.

getGreekSizeLimit

public static double getGreekSizeLimit()
Method to tell the smallest object that can be drawn. Anything smaller than this amount (in screen pixels) is "greeked", or drawn approximately. Also, any cell whose complete contents (hierarchically to the bottom) are all smaller than this size will be "greeked". The default is 3, meaning that any node or arc smaller than 3 pixels will not be drawn accurately, but will be "greeked".

Returns:
the smallest object that can be drawn.

setGreekSizeLimit

public static void setGreekSizeLimit(double l)
Method to set the smallest object that can be drawn. Anything smaller than this amount (in screen pixels) is "greeked", or drawn approximately. Also, any cell whose complete contents (hierarchically to the bottom) are all smaller than this size will be "greeked".

Parameters:
l - the smallest object that can be drawn.

getFactoryGreekSizeLimit

public static double getFactoryGreekSizeLimit()
Method to tell the smallest object that can be drawn, by default. Anything smaller than this amount (in screen pixels) is "greeked", or drawn approximately. Also, any cell whose complete contents (hierarchically to the bottom) are all smaller than this size will be "greeked".

Returns:
the smallest object that can be drawn, by default.

getGreekCellSizeLimit

public static double getGreekCellSizeLimit()
Method to tell the ratio of cell size to screen size beyond which no cell greeking happens. Any cell that fills more than this fraction of the screen will not be greeked. The default is 0.1, meaning that cells larger than 10% of the screen will not be greeked.

Returns:
the ratio of cell size to screen size beyond which no cell greeking happens.

setGreekCellSizeLimit

public static void setGreekCellSizeLimit(double l)
Method to set the ratio of cell size to screen size beyond which no cell greeking happens. Any cell that fills more than this fraction of the screen will not be greeked.

Parameters:
l - the ratio of cell size to screen size beyond which no cell greeking happens.

getFactoryGreekCellSizeLimit

public static double getFactoryGreekCellSizeLimit()
Method to tell the ratio of cell size to screen size beyond which no cell greeking happens, by default. Any cell that fills more than this fraction of the screen will not be greeked.

Returns:
the ratio of cell size to screen size beyond which no cell greeking happens, by default.

getPatternedScaleLimit

public static double getPatternedScaleLimit()
Method to tell the scale of EditWindow when use patterned drawing. Smaller scales use solid drawing. The default is 0.5, meaning that 2 lamdas per pixel.

Returns:
the scale of EditWindow when use patterned drawing.

setPatternedScaleLimit

public static void setPatternedScaleLimit(double l)
Method to set the scale of EditWindow when use patterned drawing. Smaller scales use solid drawing.

Parameters:
l - the scale of EditWindow when use patterned drawing.

getFactoryPatternedScaleLimit

public static double getFactoryPatternedScaleLimit()
Method to tell the scale of EditWindow when use patterned drawing, by default. Smaller scales use solid drawing.

Returns:
the scale of EditWindow when use patterned drawing, by default.

isLegacyComposite

public static boolean isLegacyComposite()
Method to tell whether to use lagacy composite in LayerDrawing. The default is false, meaning that use (overcolor) alpha blending.

Returns:
true to use lagacy composite in LayerDrawing.

setLegacyComposite

public static void setLegacyComposite(boolean on)
Method to set whether to use lagacy composite in LayerDrawing.

Parameters:
on - true to use lagacy composite in LayerDrawing.

isFactoryLegacyComposite

public static boolean isFactoryLegacyComposite()
Method to tell whether to use lagacy composite in LayerDrawing, by default.

Returns:
true to use lagacy composite in LayerDrawing, by default.

getAlphaBlendingOvercolorLimit

public static double getAlphaBlendingOvercolorLimit()
Method to tell the scale of EditWindow when use overcolor in alpha blending color composite. Smaller scales don't use overcolor. The default is 0.6, meaning that 1.66 lamdas per pixel.

Returns:
the scale of EditWindow when use overcolor in alpha blending.

setAlphaBlendingOvercolorLimit

public static void setAlphaBlendingOvercolorLimit(double l)
Method to set the scale of EditWindow when use overcolor in alpha blending color composite. Smaller scales don't use overcolor.

Parameters:
l - the scale of EditWindow when use overcolor in alpha blending.

getFactoryAlphaBlendingOvercolorLimit

public static double getFactoryAlphaBlendingOvercolorLimit()
Method to tell the scale of EditWindow when use overcolor in alpha blending color composite, by default. Smaller scales don't use overcolor.

Returns:
the scale of EditWindow when use overcolor in alpha blending, by default.

isShowFileSelectionForNetlists

public static boolean isShowFileSelectionForNetlists()
Method to tell whether to display a file selection dialog before writing netlists. The default is "true".

Returns:
true if the system should display a file selection dialog before writing netlists.

setShowFileSelectionForNetlists

public static void setShowFileSelectionForNetlists(boolean on)
Method to set whether to display a file selection dialog before writing netlists.

Parameters:
on - true if the system should display a file selection dialog before writing netlists.

isFactoryShowFileSelectionForNetlists

public static boolean isFactoryShowFileSelectionForNetlists()
Method to tell whether to display a file selection dialog before writing netlists, by default.

Returns:
true if the system should display a file selection dialog before writing netlists, by default.

getPanningDistance

public static int getPanningDistance()
Method to tell the distance to pan when shifting the screen or rolling the mouse wheel. The values are: 0=small, 1=medium, 2=large. The default is 1.

Returns:
the distance to pan when shifting the screen or rolling the mouse wheel.

setPanningDistance

public static void setPanningDistance(int d)
Method to set the distance to pan when shifting the screen or rolling the mouse wheel.

Parameters:
d - the distance to pan when shifting the screen or rolling the mouse wheel. The values are: 0=small, 1=medium, 2=large.

getFactoryPanningDistance

public static int getFactoryPanningDistance()
Method to tell the distance to pan when shifting the screen or rolling the mouse wheel, by default. The values are: 0=small, 1=medium, 2=large.

Returns:
the distance to pan when shifting the screen or rolling the mouse wheel, by default.

getDisplayStyle

public static int getDisplayStyle()
Method to tell the initial display style for Electric. The values are: 0=OS default, 1=MDI, 2=SDI. The default is 0.

Returns:
the display style for Electric.

setDisplayStyle

public static void setDisplayStyle(int s)
Method to set the initial display style for Electric.

Parameters:
s - the display style for Electric. The values are: 0=OS default, 1=MDI, 2=SDI. Changes do not take effect until Electric is restarted.

getFactoryDisplayStyle

public static int getFactoryDisplayStyle()
Method to tell the initial display style for Electric, by default. The values are: 0=OS default, 1=MDI, 2=SDI.

Returns:
the display style for Electric, by default.

getErrorLimit

public static int getErrorLimit()
Method to tell the maximum number of errors to log. The default is 0, which means that there is no limit.

Returns:
the maximum number of errors to log.

setErrorLimit

public static void setErrorLimit(int limit)
Method to set the maximum number of errors to log.

Parameters:
limit - the maximum number of errors to log. A value of zero indicates that there is no limit.

getFactoryErrorLimit

public static int getFactoryErrorLimit()
Method to tell the maximum number of errors to log, by default. The value 0 which means that there is no limit.

Returns:
the maximum number of errors to log, by default.

getMaxUndoHistory

public static int getMaxUndoHistory()
Method to get the maximum number of undos retained in memory


setMaxUndoHistory

public static void setMaxUndoHistory(int n)
Method to set the maximum number of undos retained in memory


getFactoryMaxUndoHistory

public static int getFactoryMaxUndoHistory()
Method to get the maximum number of undos retained in memory, by default.


getMemorySize

public static int getMemorySize()
Method to tell the maximum memory to use for Electric, in megatybes. The default is 65 megabytes which is not enough for serious work.

Returns:
the maximum memory to use for Electric (in megabytes).

setMemorySize

public static void setMemorySize(int limit)
Method to set the maximum memory to use for Electric.

Parameters:
limit - maximum memory to use for Electric (in megabytes).

getFactoryMemorySize

public static int getFactoryMemorySize()
Method to tell the maximum memory to use for Electric (in megabytes), by default.

Returns:
the maximum memory to use for Electric (in megabytes), by default.

getPermSpace

public static int getPermSpace()
Method to tell the maximum permanent space of 2dn GC to use for Electric, in megatybes. The default is 0. If zero, value is not considered.

Returns:
the maximum memory to use for Electric (in megabytes).

setPermSpace

public static void setPermSpace(int limit)
Method to set the maximum permanent space of 2dn GC to use for Electric.

Parameters:
limit - maximum permanent space of 2dn GC to use for Electric (in megabytes).

getFactoryPermSpace

public static int getFactoryPermSpace()
Method to tell the maximum permanent space of 2dn GC to use for Electric (in megatybes), by default. If zero, value is not considered.

Returns:
the maximum memory to use for Electric (in megabytes), by default.

isUseTwoJVMs

public static boolean isUseTwoJVMs()
Method to tell whether to use two JVMs when running Electric. When using two JVMs, there is a client and a server, in separate memory spaces. The default is "false".

Returns:
true to use two JVMs when running Electric.

setUseTwoJVMs

public static void setUseTwoJVMs(boolean on)
Method to set whether to use two JVMs when running Electric. When using two JVMs, there is a client and a server, in separate memory spaces.

Parameters:
on - true to use two JVMs when running Electric.

isFactoryUseTwoJVMs

public static boolean isFactoryUseTwoJVMs()
Method to tell whether to use two JVMs when running Electric, by default. When using two JVMs, there is a client and a server, in separate memory spaces.

Returns:
true to use two JVMs when running Electric, by default.

isUseClientServer

public static boolean isUseClientServer()
Method to tell whether to use a separate client and server for Electric. The default is "false".

Returns:
true to use a separate client and server for Electric

setUseClientServer

public static void setUseClientServer(boolean on)
Method to set whether to use a separate client and server for Electric

Parameters:
on - true to use a separate client and server for Electric

isFactoryUseClientServer

public static boolean isFactoryUseClientServer()
Method to tell whether to use a separate client and server for Electric, by default.

Returns:
true to use a separate client and server for Electric, by default.

isSnapshotLogging

public static boolean isSnapshotLogging()
Method to tell whether to perform snapshot logging in a temporary file. The default is "false".

Returns:
true to perform snapshot logging in a temporary file

setSnapshotLogging

public static void setSnapshotLogging(boolean on)
Method to set whether to perform snapshot logging in a temporary file

Parameters:
on - true to perform snapshot logging iu a temporary file

isFactorySnapshotLogging

public static boolean isFactorySnapshotLogging()
Method to tell whether to perform snapshot logging in a temporary file, by default.

Returns:
true to perform snapshot logging in a temporary file

isAutoTechnologySwitch

public static boolean isAutoTechnologySwitch()
Method to tell whether to switch technologies automatically when changing the current Cell. Switching technologies means that the component menu updates to the new primitive set. The default is "true".

Returns:
true if the system should switch technologies automatically when changing the current Cell.

setAutoTechnologySwitch

public static void setAutoTechnologySwitch(boolean on)
Method to set whether to switch technologies automatically when changing the current Cell. Switching technologies means that the component menu updates to the new primitive set.

Parameters:
on - true if the system should switch technologies automatically when changing the current Cell.

isFactoryAutoTechnologySwitch

public static boolean isFactoryAutoTechnologySwitch()
Method to tell whether to switch technologies automatically when changing the current Cell, by default. Switching technologies means that the component menu updates to the new primitive set.

Returns:
true if the system should switch technologies automatically when changing the current Cell, by default.

isPlaceCellCenter

public static boolean isPlaceCellCenter()
Method to tell whether to place a Cell-Center primitive in every newly created Cell. The default is "true".

Returns:
true if the system should place a Cell-Center primitive in every newly created Cell.

setPlaceCellCenter

public static void setPlaceCellCenter(boolean on)
Method to set whether to place a Cell-Center primitive in every newly created Cell.

Parameters:
on - true if the system should place a Cell-Center primitive in every newly created Cell.

isFactoryPlaceCellCenter

public static boolean isFactoryPlaceCellCenter()
Method to tell whether to place a Cell-Center primitive in every newly created Cell, by default.

Returns:
true if the system should place a Cell-Center primitive in every newly created Cell, by default.

isReconstructArcsAndExportsToDeletedCells

public static boolean isReconstructArcsAndExportsToDeletedCells()
Method to tell whether to reconstruct arcs and exports to deleted cell instances. When true, deleting a cell instance will leave the connecting arcs in place (terminated with pins) and will leave existing exports in place (sitting on pins). The default is "true".

Returns:
true if the system should reconstruct arcs and exports to deleted cell instances.

setReconstructArcsAndExportsToDeletedCells

public static void setReconstructArcsAndExportsToDeletedCells(boolean on)
Method to set whether to reconstruct arcs and exports to deleted cell instances. When true, deleting a cell instance will leave the connecting arcs in place (terminated with pins) and will leave existing exports in place (sitting on pins).

Parameters:
on - true if the system should reconstruct arcs and exports to deleted cell instances.

isFactoryReconstructArcsAndExportsToDeletedCells

public static boolean isFactoryReconstructArcsAndExportsToDeletedCells()
Method to tell whether to reconstruct arcs and exports to deleted cell instances, by default. When true, deleting a cell instance will leave the connecting arcs in place (terminated with pins) and will leave existing exports in place (sitting on pins).

Returns:
true if the system should reconstruct arcs and exports to deleted cell instances, by default.

isCheckCellDates

public static boolean isCheckCellDates()
Method to tell whether to check Cell dates when placing instances. This is not currently implemented. The default is "false".

Returns:
true if the system should check Cell dates when placing instances.

setCheckCellDates

public static void setCheckCellDates(boolean on)
Method to set whether to check Cell dates when placing instances. This is not currently implemented.

Parameters:
on - true if the system should check Cell dates when placing instances.

isFactoryCheckCellDates

public static boolean isFactoryCheckCellDates()
Method to tell whether to check Cell dates when placing instances, by default. This is not currently implemented.

Returns:
true if the system should check Cell dates when placing instances, by default.

isDisallowModificationLockedPrims

public static boolean isDisallowModificationLockedPrims()
Method to tell whether locked primitives can be modified. Locked primitives occur in array-technologies such as FPGA. The default is "false".

Returns:
true if the locked primitives cannot be modified.

setDisallowModificationLockedPrims

public static void setDisallowModificationLockedPrims(boolean on)
Method to set whether locked primitives can be modified. Locked primitives occur in array-technologies such as FPGA.

Parameters:
on - true if locked primitives cannot be modified.

isFactoryDisallowModificationLockedPrims

public static boolean isFactoryDisallowModificationLockedPrims()
Method to tell whether locked primitives can be modified by default. Locked primitives occur in array-technologies such as FPGA.

Returns:
true if the locked primitives cannot be modified by default.

isDisallowModificationComplexNodes

public static boolean isDisallowModificationComplexNodes()
Method to tell whether complex nodes can be modified. Complex nodes are cell instances and advanced primitives (transistors, etc.) The default is "false" (modifications are NOT disallowed).

Returns:
true if the complex nodes cannot be modified.

setDisallowModificationComplexNodes

public static void setDisallowModificationComplexNodes(boolean on)
Method to set whether complex nodes can be modified. Complex nodes are cell instances and advanced primitives (transistors, etc.)

Parameters:
on - true if complex nodes cannot be modified.

isFactoryDisallowModificationComplexNodes

public static boolean isFactoryDisallowModificationComplexNodes()
Method to tell whether complex nodes can be modified by default. Complex nodes are cell instances and advanced primitives (transistors, etc.)

Returns:
true if the complex nodes cannot be modified by default.

isMoveAfterDuplicate

public static boolean isMoveAfterDuplicate()
Method to tell whether to move objects after duplicating them. The default is "true".

Returns:
true if the system should move objects after duplicating them.

setMoveAfterDuplicate

public static void setMoveAfterDuplicate(boolean on)
Method to set whether to move objects after duplicating them.

Parameters:
on - true if the system should move objects after duplicating them.

isFactoryMoveAfterDuplicate

public static boolean isFactoryMoveAfterDuplicate()
Method to tell whether to move objects after duplicating them, by default.

Returns:
true if the system should move objects after duplicating them, by default.

isDupCopiesExports

public static boolean isDupCopiesExports()
Method to tell whether Duplicate/Paste/Array of NodeInst copies exports. The default is "false".

Returns:
true if the system copies exports when doing a Duplicate/Paste/Array of a NodeInst.

setDupCopiesExports

public static void setDupCopiesExports(boolean on)
Method to set whether Duplicate/Paste/Array of NodeInst copies exports.

Parameters:
on - true if the system copies exports when doing a Duplicate/Paste/Array of a NodeInst.

isFactoryDupCopiesExports

public static boolean isFactoryDupCopiesExports()
Method to tell whether Duplicate/Paste/Array of NodeInst copies exports, by default.

Returns:
true if the system copies exports when doing a Duplicate/Paste/Array of a NodeInst, by default.

isExtractCopiesExports

public static boolean isExtractCopiesExports()
Method to tell whether Extract of NodeInst copies exports. The default is "false".

Returns:
true if the system copies exports when doing an Extract of a NodeInst.

setExtractCopiesExports

public static void setExtractCopiesExports(boolean on)
Method to set whether Extract of NodeInst copies exports.

Parameters:
on - true if the system copies exports when doing an Extract of a NodeInst.

isFactoryExtractCopiesExports

public static boolean isFactoryExtractCopiesExports()
Method to tell whether Extract of NodeInst copies exports, by default.

Returns:
true if the system copies exports when doing an Extract of a NodeInst, by default.

isArcsAutoIncremented

public static boolean isArcsAutoIncremented()
Method to tell whether Duplicate/Paste/Array of ArcInsts auto-increments arc names. The default is "true".

Returns:
true if the system auto-increments arc names when doing a Duplicate/Paste/Array.

setArcsAutoIncremented

public static void setArcsAutoIncremented(boolean on)
Method to set whether Duplicate/Paste/Array of ArcInsts auto-increments arc names.

Parameters:
on - true if the system auto-increments arc names when doing a Duplicate/Paste/Array.

isFactoryArcsAutoIncremented

public static boolean isFactoryArcsAutoIncremented()
Method to tell whether Duplicate/Paste/Array of ArcInsts auto-increments arc names, by default.

Returns:
true if the system auto-increments arc names when doing a Duplicate/Paste/Array, by default.

getNewNodeRotation

public static int getNewNodeRotation()
Method to return the default rotation of all new nodes. The default is 0.

Returns:
the default rotation of all new nodes.

setNewNodeRotation

public static void setNewNodeRotation(int rot)
Method to set the default rotation of all new nodes.

Parameters:
rot - the default rotation of all new nodes.

isNewNodeMirrorX

public static boolean isNewNodeMirrorX()
Method to tell whether new nodes are mirrored in X. The default is "false".

Returns:
true if new nodes are mirrored in X.

setNewNodeMirrorX

public static void setNewNodeMirrorX(boolean on)
Method to set whether new nodes are mirrored in X.

Parameters:
on - true if new nodes are mirrored in X.

getWaveformDigitalPanelHeight

public static int getWaveformDigitalPanelHeight()
Method to tell the height of digital waveform panels. The default is "25".

Returns:
the height of digital waveform panels.

setWaveformDigitalPanelHeight

public static void setWaveformDigitalPanelHeight(int h)
Method to set the height of digital waveform panels.

Parameters:
h - the height of digital waveform panels.

getWaveformAnalogPanelHeight

public static int getWaveformAnalogPanelHeight()
Method to tell the height of analog waveform panels. The default is "75".

Returns:
the height of analog waveform panels.

setWaveformAnalogPanelHeight

public static void setWaveformAnalogPanelHeight(int h)
Method to set the height of analog waveform panels.

Parameters:
h - the height of analog waveform panels.