Method Detail

• lockClientSession

  public static void lockClientSession(boolean on)

  Locks or not the session.

• isClientSessionLocked

  protected boolean isClientSessionLocked(PPanel requestingPanel)

  Method checked for panel lock in every panel. A subclass may override this method in order to lock the panel in question.

  The default implementation is to return false.

  Overrides:

  isClientSessionLocked in class Phantom

  Parameters:

  requestingPanel - The panel requesting the client session lock state.

• setLAF

  protected int setLAF(String s)

  Sets a look-and-feel from a string that can be separated by comma or colon.

  Overrides:

  setLAF in class Phantom

  Parameters:

  s - The Look-and-Feel name such as "system", "metal", "jlf", or the exact class name (case insensitive, a string that is contained in the Look-and-Feel name itself (except if it's "Windows" and Look-and-Feel name is "Windows Classic").

  Returns:

  The Look-and-Feel changed = 1, no change = 0, or "-1" it's the same Look-and-Feel with same scaling or the Look-and-Feel did not exist. Return value is -2 if this function has been called once before.

• _setClosingWindow

  protected void _setClosingWindow(Window owner,
                                   boolean on)

  Changes the state of closing window. This should only be used internally!

  Overrides:

  _setClosingWindow in class Phantom

• _showOptionDialog

  protected int _showOptionDialog(Component parentComponent,
                                  Object message,
                                  String title,
                                  int optionType,
                                  int messageType,
                                  Icon icon,
                                  Object[] options,
                                  Object initialValue)

  Brings up a dialog with a specified icon, where the initial choice is determined by the initialValue parameter and the number of choices is determined by the optionType parameter.

  If optionType is YES_NO_OPTION, or YES_NO_CANCEL_OPTION and the options parameter is null, then the options are supplied by the look and feel.

  The messageType parameter is primarily used to supply a default icon from the look and feel.

  Overrides:

  _showOptionDialog in class Phantom

  Parameters:

  parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

  message - the Object to display

  title - the title string for the dialog

  optionType - an integer designating the options available on the dialog: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

  messageType - an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

  icon - the icon to display in the dialog

  options - an array of objects indicating the possible choices the user can make; if the objects are components, they are rendered properly; non-String objects are rendered using their toString methods; if this parameter is null, the options are determined by the Look and Feel

  initialValue - the object that represents the default selection for the dialog; only meaningful if options is used; can be null

  Returns:

  an integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog

  Throws:

  HeadlessException - if GraphicsEnvironment.isHeadless returns true

  See Also:

  GraphicsEnvironment.isHeadless()

• getAppletInfo

  public String getAppletInfo()

  Gets the Applet information.

  Overrides:

  getAppletInfo in class Phantom

  Returns:

  A string containing information about the Applet.

• onTerminalWindowDisplayed

  protected void onTerminalWindowDisplayed(PPanel panel,
                                           Terminal terminal)

  Called when the terminal window has been displayed. Superclasses (the editor) uses this to save the instance of the component for drawing purposes.

  Overrides:

  onTerminalWindowDisplayed in class Phantom

  Parameters:

  panel - the terminal window Phantom panel

  terminal - the terminal window instance

• exitMessage0

  protected int exitMessage0(String msg)

  Shows a message Dialog with an Exit message.

  Overrides:

  exitMessage0 in class Phantom

  Parameters:

  msg - A string to display in the message box.

  Returns:

  0 to process the request normally,
  1 to stop further processing.

• isEditor

  public boolean isEditor()

  Checks if this is the editor or not.

  Overrides:

  isEditor in class Phantom

  Returns:

  true always.

• notifyModalPanelCreation

  public void notifyModalPanelCreation(JDialog dialog)

  For the editor, this notifies that a modal panel has been created.

  Overrides:

  notifyModalPanelCreation in class Phantom

• createTerminalWindow

  public TerminalWindow createTerminalWindow(Container terminalParent,
                                             Container container,
                                             Color[] cgaColors,
                                             String ii,
                                             String im,
                                             String mw,
                                             String caps,
                                             String num,
                                             int cx,
                                             int cy,
                                             int x,
                                             int y,
                                             char[] cd,
                                             int[] ad,
                                             TerminalWindowListener listener)

  Create the terminal window. The PhantomEditor superclass uses another terminal window.

  Overrides:

  createTerminalWindow in class Phantom

• disposeConnectFrame

  protected void disposeConnectFrame(Window w)

  Closes connection window.

  Overrides:

  disposeConnectFrame in class Phantom

• adjustPanelPosition

  public void adjustPanelPosition(JDialog dialog,
                                  PPanel panel,
                                  Rectangle bounds)

  Called just before a pop-up panel is about to be displayed and allows a superclass to change to position of the window before it is displayed.

  Overrides:

  adjustPanelPosition in class Phantom

• showOptionDialog0

  protected int showOptionDialog0(Component parentComponent,
                                  Object[] components,
                                  String message,
                                  String title,
                                  int optionType,
                                  int messageType,
                                  Icon icon,
                                  Object[] options,
                                  Object initialValue)

  For the editor, overridden to handle menu states in the panel part. In Win32 thread, this is handled like Win32 message boxes with a message queue loop.

  Overrides:

  showOptionDialog0 in class Phantom

• onMessageBoxCountChanged

  protected void onMessageBoxCountChanged()

  Called when the message box count has changed. Subclasses may override this method. The implementation of this method does nothing.

  Overrides:

  onMessageBoxCountChanged in class Phantom

• onNextDialogOwner

  protected void onNextDialogOwner(JFrame frame,
                                   JDialog dialog)

  Called when the before the next dialog is to be shown, modally or not. This method can be overridden to add hooks to the dialog if it is e.g. modal, and to handle special focus issues, typically for the Editor with the Win32 Panel Part window.

  This method is ALWAYS called in the AWT thread.

  Overrides:

  onNextDialogOwner in class Phantom

  Parameters:

  frame - the Frame owner of the dialog.

  dialog - The dialog that will be shown.

• logConsole

  public void logConsole(String text)

  Prints an event to the Java Console, defaults to System.out. Subclasses can override this method to handle redirection of the output.

  Specified by:

  logConsole in interface ILogConsole

  Overrides:

  logConsole in class Phantom

• onUITweaks

  public void onUITweaks(UITweaks tweaks)

  Called when new tweaks are applied.

  Specified by:

  onUITweaks in interface IPhantomFontScaling

  Overrides:

  onUITweaks in class Phantom

  Parameters:

  tweaks - The new tweaks for the Look-and-Feel.

• getEditorWindows

  public Set<Window> getEditorWindows()

  Gets the Editor's windows. This method is overridden by NetPhantom Editor so that the Windows created will not be affected by the Look-and-Feel changes for designed panels.

  Specified by:

  getEditorWindows in interface IPhantomFontScaling

  Overrides:

  getEditorWindows in class Phantom

  Returns:

  The set of Editor windows.

• onNewWindow

  public void onNewWindow(Window w)

  Called when a new panel Frame or Dialog window is created. This method is overridden by NetPhantom Editor so that the Window created will not be affected by the Look-and-Feel changes for designed panels.

  Overrides:

  onNewWindow in class Phantom

  Parameters:

  w - The Window created (PJFrame, PJDialog or JDialog).

• onPopupMenuSoon

  protected void onPopupMenuSoon()

  Apply the Editor Look-and-Feel because a pop-up menu will be shown. This method is overridden by NetPhantom Editor so that the Window created will not be affected by the Look-and-Feel changes for designed panels.

  Overrides:

  onPopupMenuSoon in class Phantom

• onPopupMenuDisposed

  protected void onPopupMenuDisposed()

  Apply the Designer Look-and-Feel because an Editor pop-up menu has been hidden. This method is overridden by NetPhantom Editor so that the Window created will not be affected by the Look-and-Feel changes for designed panels.

  Overrides:

  onPopupMenuDisposed in class Phantom