com.sun.electric.database.variable
Interface UserInterface

All Known Implementing Classes:
AbstractUserInterface, Main.UserInterfaceDummy, UserInterfaceExec, UserInterfaceMain

public interface UserInterface

This interface provides information from the user interface.


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)
           
 

Method Detail

getJobKey

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.


getDatabase

EDatabase getDatabase()
Method to return the current database object.

Returns:
the current database (null if none).

getCurrentTechnology

Technology getCurrentTechnology()
Method to return the current Technology.

Returns:
the current database (null if none).

getCurrentLibrary

Library getCurrentLibrary()
Method to return the current Library.

Returns:
the current Library.

getCurrentEditWindow_

EditWindow_ getCurrentEditWindow_()
Method to return the current "EditWindow_" object.

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

needCurrentEditWindow_

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

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

getCurrentCell

Cell getCurrentCell()
Method to return the current Cell in the current Library.

Returns:
the current Cell (null if none).

needCurrentCell

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

Returns:
the current Cell (null if none).

adjustReferencePoint

void adjustReferencePoint(Cell cell,
                          double cX,
                          double cY)
Method to adjust reference point in WindowFrame containing the cell


repaintAllWindows

void repaintAllWindows()
Method to request that all windows be redisplayed including palettes.


getDefaultTextSize

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

Returns:
the height of default text (in points).

displayCell

EditWindow_ displayCell(Cell cell)
Method to request that a Cell be displayed in a new window.

Parameters:
cell - the Cell to be displayed.
Returns:
the EditWindow_ object created to show the Cell.

termLogging

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

reportLog

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).


showErrorMessage

void showErrorMessage(java.lang.String message,
                      java.lang.String title)
Method to show an error message.

Parameters:
message - the error message to show.
title - the title of a dialog with the error message.

showInformationMessage

void showInformationMessage(java.lang.String message,
                            java.lang.String title)
Method to show an informational message.

Parameters:
message - the message to show.
title - the title of a dialog with the message.

printMessage

void printMessage(java.lang.String message,
                  boolean newLine)
Method print a message.

Parameters:
message - the message to show.
newLine - add new line after the message

saveMessages

void saveMessages(java.lang.String filePath)
Method to start saving messages.

Parameters:
filePath - file to save

beep

void beep()
Method to beep.


confirmMessage

boolean confirmMessage(java.lang.Object message)
Method to show a message and ask for confirmation.

Parameters:
message - the message to show.
Returns:
true if "yes" was selected, false if "no" was selected.

askForChoice

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.

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

java.lang.String askForInput(java.lang.Object message,
                             java.lang.String title,
                             java.lang.String def)
Method to ask for a line of text.

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

void startProgressDialog(java.lang.String msg,
                         java.lang.String filePath)
Method to start the display of a progress dialog.

Parameters:
msg - the message to show in the progress dialog.
filePath - the file being read (null if not reading a file).

stopProgressDialog

void stopProgressDialog()
Method to stop the progress bar


setProgressValue

void setProgressValue(int pct)
Method to update the progress bar

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

setProgressNote

void setProgressNote(java.lang.String message)
Method to set a text message in the progress dialog.

Parameters:
message - the new progress message.

getProgressNote

java.lang.String getProgressNote()
Method to get text message in the progress dialgo.

Returns:
the current progress message.