com.sun.electric.database.variable
Interface UserInterface

All Known Implementing Classes:

AbstractUserInterface, 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
void	alignToGrid(java.awt.geom.Point2D pt) Method to align a database coordinate with the current grid.
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.
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.
void	exportPrefs() Method to export the preferences to an XML file.
Cell	getCurrentCell() Method to return the current Cell in the current Library.
Cell	getCurrentCell(Library lib) Method to get the current Cell in a given Library.
EditWindow_	getCurrentEditWindow_() Method to return the current "EditWindow_" object.
int	getDefaultTextSize() Method to return the height of default text (in points).
Dimension2D	getGridAlignment() Method to get the current grid alignment.
java.lang.String	getProgressNote() Method to get text message in the progress dialgo.
void	importPrefs() Method to import the preferences from an XML file.
Cell	needCurrentCell() Method to demand the current Cell.
EditWindow_	needCurrentEditWindow_() Method to demand the current "EditWindow_" object.
void	repaintAllWindows() Method to request that all windows be redisplayed including palettes.
java.lang.String	reportLog(ErrorLogger.MessageLog log, boolean showhigh, Geometric[] gPair) Method to return the error message associated with the current error.
void	setCurrentCell(Library lib, Cell curCell) Method to set the current Cell in a Library.
void	setProgressNote(java.lang.String message) Method to set a text message in the progress dialog.
void	setProgressValue(long pct) Method to update the progress bar
void	showErrorMessage(java.lang.Object message, java.lang.String title) Method to show an error message.
void	showInformationMessage(java.lang.Object 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

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

getCurrentCell

Cell getCurrentCell(Library lib)

Method to get the current Cell in a given Library.

Parameters:

lib - the library to query.

Returns:

the current Cell in the Library.

needCurrentCell

Cell needCurrentCell()

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

Returns:

the current Cell (null if none).

setCurrentCell

void setCurrentCell(Library lib,
                    Cell curCell)

Method to set the current Cell in a Library.

Parameters:

lib - the library in which to set a current cell.

curCell - the new current Cell in the Library (can be null).

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.

alignToGrid

void alignToGrid(java.awt.geom.Point2D pt)

Method to align a database coordinate with the current grid.

Parameters:

pt - the database coordinate. It's value is adjusted.

getGridAlignment

Dimension2D getGridAlignment()

Method to get the current grid alignment.

Returns:

the current grid alignment.

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)

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

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

importPrefs

void importPrefs()

Method to import the preferences from an XML file. Prompts the user and reads the file.

exportPrefs

void exportPrefs()

Method to export the preferences to an XML file. Prompts the user and writes the file.

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(long 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.