com.sun.electric.tool
Class UserInterfaceExec

java.lang.Object
  com.sun.electric.tool.UserInterfaceExec

All Implemented Interfaces:

UserInterface

public class UserInterfaceExec
extends java.lang.Object
implements UserInterface

User Interface for Exec threads

Constructor Summary

UserInterfaceExec()

Method Summary

void	adjustReferencePoint(Cell cell, double cX, double cY) Method to adjust reference point in WindowFrame containing the cell
int	askForChoice(java.lang.String message, java.lang.String title, java.lang.String[] choices, java.lang.String defaultChoice) Method to ask for a choice among possibilities.
java.lang.String	askForInput(java.lang.Object message, java.lang.String title, java.lang.String def) Method to ask for a line of text.
void	beep() Method to beep.
boolean	confirmMessage(java.lang.Object message) Method to show a message and ask for confirmation.
EditWindow_	displayCell(Cell cell) Method to request that a Cell be displayed in a new window.
Cell	getCurrentCell() Method to return the current Cell in the current Library.
EditWindow_	getCurrentEditWindow_() Method to return the current "EditWindow_" object.
Library	getCurrentLibrary() Method to return the current Library.
Technology	getCurrentTechnology() Method to return the current Technology.
EDatabase	getDatabase() Method to return the current database object.
int	getDefaultTextSize() Method to return the height of default text (in points).
Job.Key	getJobKey() Method to return Job Key of a currently executed Job.
java.lang.String	getProgressNote() Method to get text message in the progress dialgo.
Cell	needCurrentCell() Method to demand the current Cell.
EditWindow_	needCurrentEditWindow_() Method to demand the current "EditWindow_" object.
void	printMessage(java.lang.String message, boolean newLine) Method print a message.
void	repaintAllWindows() Method to request that all windows be redisplayed including palettes.
java.lang.String	reportLog(ErrorLogger.MessageLog log, boolean showhigh, Geometric[] gPair, int position) Method to return the error message associated with the current error.
void	saveMessages(java.lang.String filePath) Method to start saving messages.
void	setProgressNote(java.lang.String message) Method to set a text message in the progress dialog.
void	setProgressValue(int pct) Method to update the progress bar
void	showErrorMessage(java.lang.String message, java.lang.String title) Method to show an error message.
void	showInformationMessage(java.lang.String message, java.lang.String title) Method to show an informational message.
void	startProgressDialog(java.lang.String msg, java.lang.String filePath) Method to start the display of a progress dialog.
void	stopProgressDialog() Method to stop the progress bar
void	termLogging(ErrorLogger logger, boolean explain, boolean terminate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserInterfaceExec

public UserInterfaceExec()

Method Detail

getJobKey

public Job.Key getJobKey()

Method to return Job Key of a currently executed Job. Jobless context (Gui) is represented by a Job Key with jobId=0.

Specified by:

getJobKey in interface UserInterface

getDatabase

public EDatabase getDatabase()

Method to return the current database object.

Specified by:

getDatabase in interface UserInterface

Returns:

the current database (null if none).

getCurrentTechnology

public Technology getCurrentTechnology()

Method to return the current Technology.

Specified by:

getCurrentTechnology in interface UserInterface

Returns:

the current database (null if none).

getCurrentLibrary

public Library getCurrentLibrary()

Method to return the current Library.

Specified by:

getCurrentLibrary in interface UserInterface

Returns:

the current Library.

getCurrentEditWindow_

public EditWindow_ getCurrentEditWindow_()

Method to return the current "EditWindow_" object.

Specified by:

getCurrentEditWindow_ in interface UserInterface

Returns:

the current "EditWindow_" object (null if none).

needCurrentEditWindow_

public EditWindow_ needCurrentEditWindow_()

Method to demand the current "EditWindow_" object. If none exists, an error message is displayed.

Specified by:

needCurrentEditWindow_ in interface UserInterface

Returns:

the current "EditWindow_" object (null if none).

getCurrentCell

public Cell getCurrentCell()

Method to return the current Cell in the current Library.

Specified by:

getCurrentCell in interface UserInterface

Returns:

the current Cell (null if none).

needCurrentCell

public Cell needCurrentCell()

Method to demand the current Cell. If none exists, an error message is displayed.

Specified by:

needCurrentCell in interface UserInterface

Returns:

the current Cell (null if none).

adjustReferencePoint

public void adjustReferencePoint(Cell cell,
                                 double cX,
                                 double cY)

Method to adjust reference point in WindowFrame containing the cell

Specified by:

adjustReferencePoint in interface UserInterface

repaintAllWindows

public void repaintAllWindows()

Method to request that all windows be redisplayed including palettes.

Specified by:

repaintAllWindows in interface UserInterface

getDefaultTextSize

public int getDefaultTextSize()

Method to return the height of default text (in points).

Specified by:

getDefaultTextSize in interface UserInterface

Returns:

the height of default text (in points).

displayCell

public EditWindow_ displayCell(Cell cell)

Method to request that a Cell be displayed in a new window.

Specified by:

displayCell in interface UserInterface

Parameters:

cell - the Cell to be displayed.

Returns:

the EditWindow_ object created to show the Cell.

termLogging

public void termLogging(ErrorLogger logger,
                        boolean explain,
                        boolean terminate)

Specified by:

termLogging in interface UserInterface

reportLog

public java.lang.String reportLog(ErrorLogger.MessageLog log,
                                  boolean showhigh,
                                  Geometric[] gPair,
                                  int position)

Method to return the error message associated with the current error. Highlights associated graphics if "showhigh" is nonzero. Fills "g1" and "g2" with associated geometry modules (if nonzero).

Specified by:

reportLog in interface UserInterface

showErrorMessage

public void showErrorMessage(java.lang.String message,
                             java.lang.String title)

Method to show an error message.

Specified by:

showErrorMessage in interface UserInterface

Parameters:

message - the error message to show.

title - the title of a dialog with the error message.

showInformationMessage

public void showInformationMessage(java.lang.String message,
                                   java.lang.String title)

Method to show an informational message.

Specified by:

showInformationMessage in interface UserInterface

Parameters:

message - the message to show.

title - the title of a dialog with the message.

printMessage

public void printMessage(java.lang.String message,
                         boolean newLine)

Method print a message.

Specified by:

printMessage in interface UserInterface

Parameters:

message - the message to show.

newLine - add new line after the message

saveMessages

public void saveMessages(java.lang.String filePath)

Method to start saving messages.

Specified by:

saveMessages in interface UserInterface

Parameters:

filePath - file to save

beep

public void beep()

Method to beep.

Specified by:

beep in interface UserInterface

confirmMessage

public boolean confirmMessage(java.lang.Object message)

Method to show a message and ask for confirmation.

Specified by:

confirmMessage in interface UserInterface

Parameters:

message - the message to show.

Returns:

true if "yes" was selected, false if "no" was selected.

askForChoice

public int askForChoice(java.lang.String message,
                        java.lang.String title,
                        java.lang.String[] choices,
                        java.lang.String defaultChoice)

Method to ask for a choice among possibilities.

Specified by:

askForChoice in interface UserInterface

Parameters:

message - the message to show.

title - the title of the dialog with the query.

choices - an array of choices to present, each in a button.

defaultChoice - the default choice.

Returns:

the index into the choices array that was selected.

askForInput

public java.lang.String askForInput(java.lang.Object message,
                                    java.lang.String title,
                                    java.lang.String def)

Method to ask for a line of text.

Specified by:

askForInput in interface UserInterface

Parameters:

message - the prompt message.

title - the title of a dialog with the message.

def - the default response.

Returns:

the string (null if cancelled).

startProgressDialog

public void startProgressDialog(java.lang.String msg,
                                java.lang.String filePath)

Method to start the display of a progress dialog.

Specified by:

startProgressDialog in interface UserInterface

Parameters:

msg - the message to show in the progress dialog.

filePath - the file being read (null if not reading a file).

stopProgressDialog

public void stopProgressDialog()

Method to stop the progress bar

Specified by:

stopProgressDialog in interface UserInterface

setProgressValue

public void setProgressValue(int pct)

Method to update the progress bar

Specified by:

setProgressValue in interface UserInterface

Parameters:

pct - the percentage done (from 0 to 100).

setProgressNote

public void setProgressNote(java.lang.String message)

Method to set a text message in the progress dialog.

Specified by:

setProgressNote in interface UserInterface

Parameters:

message - the new progress message.

getProgressNote

public java.lang.String getProgressNote()

Method to get text message in the progress dialgo.

Specified by:

getProgressNote in interface UserInterface

Returns:

the current progress message.