Overview  Package   Class  Use  Deprecated  Index
Home >> All >> jpl2 >> common >> [ gui overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

jpl2.common.gui
Class JPLToolkit  

java.lang.Object
  jpl2.common.gui.JPLToolkit

Direct Known Subclasses:

AWTToolkit, SwingToolkit

---

public abstract class JPLToolkit

extends java.lang.Object

A class for allowig the use of AWT or Swing, without needing to now * the difference. This is so that under MacOS 9 we shall use AWT and have * a native look and feel and under Linux we shall use swing and have the * native look and feel too. Bizarre tho it sounds!

---

Field Summary
private  java.awt.Dialog	dialog
private  java.lang.String	multipleQueryResult
private static jpl2.common.Preference	prefs
private  boolean	queryResult
private static java.util.ResourceBundle	resources
private static JPLToolkit	tk

 

Constructor Summary

JPLToolkit()

 

Method Summary
abstract  void	add(java.awt.Window w, java.awt.Component c)           Adds a component to a window.
abstract  void	add(java.awt.Window w, java.awt.Component c, java.lang.Object constraints)           Adds a component to a window.
abstract  void	addMenu(java.lang.Object menuBar, java.lang.Object menu)           Add a menu to a menu bar.
abstract  void	addMenuItem(java.lang.Object menu, java.lang.Object menuItem)           Add a menu item to a menu.
abstract  void	addSeparator(java.lang.Object menu)           Insert a seperator/divider into the menu.
abstract  boolean	canChooseFolders()           Under this setup can we create a folder/directory * chooser?
void	centreWindow(java.awt.Window parent, java.awt.Window child)           Centre child relative to parent.
java.io.File	chooseFolder(java.awt.Frame parent, java.lang.String title)           Display a dialog to allow the user to choose a folder (eg for * where to download files to.
protected abstract  java.io.File	chooseFolderImp(java.awt.Frame parent, java.lang.String title)
java.io.File	chooseOpenFile(java.awt.Frame parent, java.lang.String title)           Display a dialog to allow the user to open a file.
protected abstract  java.io.File	chooseOpenFileImp(java.awt.Frame parent, java.lang.String title)
java.io.File	chooseSaveFile(java.awt.Frame parent, java.lang.String title)           Display a dialog to allow the user to save a file.
protected abstract  java.io.File	chooseSaveFileImp(java.awt.Frame parent, java.lang.String title)
static java.io.File	createTemporaryFile(java.lang.String prefix, java.lang.String suffix)           Attempt to make a temporary file (which will hopefully be deleted at exit).
java.lang.String	doMultipleQueryDialog(java.awt.Frame frame, java.lang.String title, java.lang.String query)           A query dialog that may be one of many, hence it has a "yes to all" button, as well as a yes button.
boolean	doQueryDialog(java.awt.Frame frame, java.lang.String title, java.lang.String query)           Display a simple, yes/no dialog.
java.lang.String	doTextInputDialog(java.awt.Frame frame, java.lang.String title, java.lang.String msg, java.lang.String text)
abstract  boolean	getCheckBoxState(java.awt.Component checkBox)           Get the current state of a CheckBox
java.lang.String[]	getFonts()           Get a list of installed fonts.
static jpl2.common.Preference	getPreferences()
static java.util.ResourceBundle	getResourceBundle()
static java.lang.String	getResourceString(java.lang.String key)
static java.lang.String	getResourceString(java.lang.String key, java.lang.Object[] params)
abstract  java.awt.Point	getScrollPosition(java.awt.Container scrollpane)           Returns the scroll position of a scrollpane.
abstract  java.lang.String	getSelected(java.awt.Component choice)           Get the currently selected item on a choice.
abstract  int	getSelectedIndex(java.awt.Component choice)           Get the currently selected item on a choice.
abstract  java.lang.String	getText(java.awt.Component textField)           Get the text from a text field.
static JPLToolkit	getToolkit()
abstract  java.awt.Dimension	getViewportSize(java.awt.Container scrollpane)           Returns the viewport size of a scrollpane.
void	installDragAndDrop(jpl2.PsionLink link, jpl2.link.gui.PsionBrowserPane browserPane)
private  boolean	installDragAndDrop(java.lang.String className, jpl2.PsionLink link, jpl2.link.gui.PsionBrowserPane browserPane)
static boolean	isHiddenFile(java.io.File file)           Try to see if the file is hidden or not.
static boolean	isSwingToolkitAvailable()
java.awt.Component	makeButton(java.lang.String text, java.lang.String action, java.awt.event.ActionListener listener)           Returns either a java.awt.Button or a javax.swing.JButton.
protected abstract  java.awt.Component	makeButtonImp(java.lang.String text, java.lang.String action, java.awt.event.ActionListener listener)
java.awt.Component	makeCheckBox(java.lang.String label, java.awt.event.ItemListener listener)           Returns either a java.awt.Checkbox or a javax.swing.JCheckBox
protected abstract  java.awt.Component	makeCheckBoxImpl(java.lang.String label, java.awt.event.ItemListener listener)
abstract  java.awt.Component	makeChoice(java.lang.String[] items, java.awt.event.ItemListener itemListener)           Returns either a java.awt.Choice or a javax.swing.JComboBox.
java.awt.Dialog	makeDialog(java.awt.Frame parent, java.lang.String title, boolean modal)           Returns either a java.awt.Dialog or a javax.swing.JDialog
protected abstract  java.awt.Dialog	makeDialogImp(java.awt.Frame parent, boolean modal)
java.awt.Frame	makeFrame(java.lang.String title)           Returns either a java.awt.Frame or a javax.swing.JFrame
protected abstract  java.awt.Frame	makeFrameImp()
java.awt.Container	makeGroupPanel(java.lang.String title)           Returns either a java.awt.Panel or a javax.swing.JPanel.
protected abstract  java.awt.Container	makeGroupPanelImp(java.lang.String title)
java.awt.Component	makeLabel(java.lang.String text)           Returns either a java.awt.Label or a javax.swing.JLabel.
java.awt.Component	makeLabel(java.lang.String text, int horizontalAlignment)           Returns either a java.awt.Label or a javax.swing.JLabel.
java.awt.Component	makeLabel(java.lang.String text, java.lang.Object[] params)           Returns either a java.awt.Label or a javax.swing.JLabel.
java.awt.Component	makeLabel(java.lang.String text, java.lang.Object[] params, int horizontalAlignment)           Returns either a java.awt.Label or a javax.swing.JLabel.
protected abstract  java.awt.Component	makeLabelImp(java.lang.String text, int horizontalAlignment)
abstract  java.awt.Component	makeList(java.lang.String[] items, java.awt.event.ItemListener itemListener)           Returns either a java.awt.List or a javax.swing.JList.
java.lang.Object	makeMenu(java.lang.String label)           Returns either a java.awt.Menu or a javax.swing.JMenu.
abstract  java.lang.Object	makeMenuBar()           Returns either a java.awt.MenuBar or a javax.swing.JMenuBar.
protected abstract  java.lang.Object	makeMenuImp(java.lang.String label)
java.lang.Object	makeMenuItem(java.lang.String label, java.awt.MenuShortcut s, java.lang.String action, java.awt.event.ActionListener listener)           Returns either a java.awt.MenuItem or a javax.swing.JMenuItem.
protected abstract  java.lang.Object	makeMenuItemImp(java.lang.String label, java.awt.MenuShortcut s, java.lang.String action, java.awt.event.ActionListener listener)
java.awt.Container	makeMultiLineLabel(java.lang.String text)           Make a panel, containing multiple lines of text (as labels).
abstract  java.awt.Container	makePanel()           Returns either a java.awt.Panel or a javax.swing.JPanel.
abstract  java.awt.Component	makeProgressBar()           Returns either a ProgressBar or a javax.swing.JProgressBar.
abstract  java.awt.Container	makeScrollPane(java.awt.Component contents)           Returns either a java.awt.ScrollPane of a javax.swing.JScrollPane.
abstract  java.awt.Component	makeTextField(java.lang.String text, int columns, java.awt.event.TextListener listener)           Returns either a java.awt.TextField or a javax.swing.JTextField.
abstract  void	removeAll(java.lang.Object menu)           Remove all items from a menu.
abstract  void	setButtonKey(java.awt.Dialog dialog, java.awt.Component button, int keyCode)           Associate a key press with the button.
abstract  void	setButtonKey(java.awt.Frame frame, java.awt.Component button, int keyCode)           Associate a key press with the button.
abstract  void	setCancelButton(java.awt.Dialog dialog, java.awt.Component button)           Make the button the "cancel" button on a dialog.
abstract  void	setCancelButton(java.awt.Frame frame, java.awt.Component button)           Make the button the "cancel" button on a frame.
abstract  void	setCheckBoxState(java.awt.Component checkBox, boolean state)           Set the state of a CheckBox.
abstract  void	setChoiceItems(java.awt.Component choice, java.lang.String[] items)           Set the items on a choice.
abstract  void	setDefaultButton(java.awt.Dialog dialog, java.awt.Component button)           Make the button the default on a dialog.
abstract  void	setDefaultButton(java.awt.Frame frame, java.awt.Component button)           Make the button the default on a frame.
abstract  void	setEditable(java.awt.Component textField, boolean editable)
abstract  void	setEnabled(java.lang.Object menuItem, boolean enabled)           Enable disable a menu/menuitem.
static boolean	setFileLastModified(java.io.File file, long modified)           Attempt to set the modification date on a file.
abstract  void	setHelpMenu(java.lang.Object menuBar, java.lang.Object menu)           Set the help menu on a menu bar.
abstract  void	setLayout(java.awt.Window w, java.awt.LayoutManager l)           Sets a layout for a window.
abstract  void	setListItems(java.awt.Component list, java.lang.String[] items)           Set the items on a list.
abstract  void	setMenuBar(java.awt.Frame frame, java.lang.Object menuBar)           Sets a frames menu bar.
abstract  void	setProgressBarMax(java.awt.Component progressBar, int max)           Set the max value on a progress bar.
abstract  void	setProgressBarValue(java.awt.Component progressBar, int value)           Set the current value of a progress bar.
abstract  void	setScrollPosition(java.awt.Container scrollpane, int x, int y)           Sets the scroll position of a scrollpane.
abstract  void	setSelected(java.awt.Component choice, java.lang.String item)           Set the currently selected item on a choice.
void	setText(java.awt.Component c, java.lang.String text)           Sets the text on what may be a button, label or a text field.
void	setText(java.awt.Component c, java.lang.String text, java.lang.Object[] params)           Sets the text on what may be a button, label or a text field.
protected abstract  void	setTextImp(java.awt.Component c, java.lang.String text)
void	showMessageDialog(java.awt.Frame frame, java.lang.String title, java.lang.String msg)           Display a simple dialog with a message and an ok/done button.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

tk

private static JPLToolkit tk

---

resources

private static java.util.ResourceBundle resources

---

prefs

private static jpl2.common.Preference prefs

---

queryResult

private boolean queryResult

---

multipleQueryResult

private java.lang.String multipleQueryResult

---

dialog

private java.awt.Dialog dialog

Constructor Detail

JPLToolkit

public JPLToolkit()

Method Detail

getPreferences

public static jpl2.common.Preference getPreferences()

---

getResourceBundle

public static java.util.ResourceBundle getResourceBundle()

---

getResourceString

public static java.lang.String getResourceString(java.lang.String key)

---

getResourceString

public static java.lang.String getResourceString(java.lang.String key,
                                                 java.lang.Object[] params)

---

getToolkit

public static JPLToolkit getToolkit()

---

isSwingToolkitAvailable

public static boolean isSwingToolkitAvailable()

---

installDragAndDrop

private boolean installDragAndDrop(java.lang.String className,
                                   jpl2.PsionLink link,
                                   jpl2.link.gui.PsionBrowserPane browserPane)

---

installDragAndDrop

public void installDragAndDrop(jpl2.PsionLink link,
                               jpl2.link.gui.PsionBrowserPane browserPane)

---

getFonts

public java.lang.String[] getFonts()

Get a list of installed fonts.

---

setFileLastModified

public static boolean setFileLastModified(java.io.File file,
                                          long modified)

Attempt to set the modification date on a file. * Returns true if date was changed.

---

createTemporaryFile

public static java.io.File createTemporaryFile(java.lang.String prefix,
                                               java.lang.String suffix)

Attempt to make a temporary file (which will hopefully be deleted at exit). * Returns null if this system does not support the creation of temporary files.

---

isHiddenFile

public static boolean isHiddenFile(java.io.File file)

Try to see if the file is hidden or not. * @param file * @return

---

makeFrame

public java.awt.Frame makeFrame(java.lang.String title)

Returns either a java.awt.Frame or a javax.swing.JFrame

---

makeFrameImp

protected abstract java.awt.Frame makeFrameImp()

---

makeDialog

public java.awt.Dialog makeDialog(java.awt.Frame parent,
                                  java.lang.String title,
                                  boolean modal)

Returns either a java.awt.Dialog or a javax.swing.JDialog

---

makeDialogImp

protected abstract java.awt.Dialog makeDialogImp(java.awt.Frame parent,
                                                 boolean modal)

---

add

public abstract void add(java.awt.Window w,
                         java.awt.Component c)

Adds a component to a window. In the case of swing getContentPane() must be used.

---

add

public abstract void add(java.awt.Window w,
                         java.awt.Component c,
                         java.lang.Object constraints)

Adds a component to a window. In the case of swing getContentPane() must be used.

---

setLayout

public abstract void setLayout(java.awt.Window w,
                               java.awt.LayoutManager l)

Sets a layout for a window. In the case of swing getContentPane() must be used.

---

makePanel

public abstract java.awt.Container makePanel()

Returns either a java.awt.Panel or a javax.swing.JPanel.

---

makeGroupPanel

public java.awt.Container makeGroupPanel(java.lang.String title)

Returns either a java.awt.Panel or a javax.swing.JPanel.

---

makeGroupPanelImp

protected abstract java.awt.Container makeGroupPanelImp(java.lang.String title)

---

makeButton

public java.awt.Component makeButton(java.lang.String text,
                                     java.lang.String action,
                                     java.awt.event.ActionListener listener)

Returns either a java.awt.Button or a javax.swing.JButton.

---

makeButtonImp

protected abstract java.awt.Component makeButtonImp(java.lang.String text,
                                                    java.lang.String action,
                                                    java.awt.event.ActionListener listener)

---

setDefaultButton

public abstract void setDefaultButton(java.awt.Dialog dialog,
                                      java.awt.Component button)

Make the button the default on a dialog.

---

setCancelButton

public abstract void setCancelButton(java.awt.Dialog dialog,
                                     java.awt.Component button)

Make the button the "cancel" button on a dialog. ie the button * which dismisses the dialog without takign any action.

---

setButtonKey

public abstract void setButtonKey(java.awt.Dialog dialog,
                                  java.awt.Component button,
                                  int keyCode)

Associate a key press with the button. ie so a key can be pressed instead of * using the mouse to press the button.

---

setDefaultButton

public abstract void setDefaultButton(java.awt.Frame frame,
                                      java.awt.Component button)

Make the button the default on a frame.

---

setCancelButton

public abstract void setCancelButton(java.awt.Frame frame,
                                     java.awt.Component button)

Make the button the "cancel" button on a frame. ie the button * which dismisses the frame without taking any action.

---

setButtonKey

public abstract void setButtonKey(java.awt.Frame frame,
                                  java.awt.Component button,
                                  int keyCode)

Associate a key press with the button. ie so a key can be pressed instead of * using the mouse to press the button.

---

makeLabel

public java.awt.Component makeLabel(java.lang.String text,
                                    int horizontalAlignment)

Returns either a java.awt.Label or a javax.swing.JLabel.

---

makeLabel

public java.awt.Component makeLabel(java.lang.String text,
                                    java.lang.Object[] params,
                                    int horizontalAlignment)

Returns either a java.awt.Label or a javax.swing.JLabel.

---

makeLabelImp

protected abstract java.awt.Component makeLabelImp(java.lang.String text,
                                                   int horizontalAlignment)

---

makeLabel

public java.awt.Component makeLabel(java.lang.String text)

Returns either a java.awt.Label or a javax.swing.JLabel.

---

makeLabel

public java.awt.Component makeLabel(java.lang.String text,
                                    java.lang.Object[] params)

Returns either a java.awt.Label or a javax.swing.JLabel.

---

setText

public void setText(java.awt.Component c,
                    java.lang.String text)

Sets the text on what may be a button, label or a text field.

---

setText

public void setText(java.awt.Component c,
                    java.lang.String text,
                    java.lang.Object[] params)

Sets the text on what may be a button, label or a text field.

---

setTextImp

protected abstract void setTextImp(java.awt.Component c,
                                   java.lang.String text)

---

makeMenuBar

public abstract java.lang.Object makeMenuBar()

Returns either a java.awt.MenuBar or a javax.swing.JMenuBar.

---

setMenuBar

public abstract void setMenuBar(java.awt.Frame frame,
                                java.lang.Object menuBar)

Sets a frames menu bar.

---

makeMenu

public java.lang.Object makeMenu(java.lang.String label)

Returns either a java.awt.Menu or a javax.swing.JMenu.

---

makeMenuImp

protected abstract java.lang.Object makeMenuImp(java.lang.String label)

---

addSeparator

public abstract void addSeparator(java.lang.Object menu)

Insert a seperator/divider into the menu.

---

removeAll

public abstract void removeAll(java.lang.Object menu)

Remove all items from a menu.

---

addMenu

public abstract void addMenu(java.lang.Object menuBar,
                             java.lang.Object menu)

Add a menu to a menu bar.

---

setHelpMenu

public abstract void setHelpMenu(java.lang.Object menuBar,
                                 java.lang.Object menu)

Set the help menu on a menu bar.

---

makeMenuItem

public java.lang.Object makeMenuItem(java.lang.String label,
                                     java.awt.MenuShortcut s,
                                     java.lang.String action,
                                     java.awt.event.ActionListener listener)

Returns either a java.awt.MenuItem or a javax.swing.JMenuItem.

---

makeMenuItemImp

protected abstract java.lang.Object makeMenuItemImp(java.lang.String label,
                                                    java.awt.MenuShortcut s,
                                                    java.lang.String action,
                                                    java.awt.event.ActionListener listener)

---

addMenuItem

public abstract void addMenuItem(java.lang.Object menu,
                                 java.lang.Object menuItem)

Add a menu item to a menu.

---

setEnabled

public abstract void setEnabled(java.lang.Object menuItem,
                                boolean enabled)

Enable disable a menu/menuitem.

---

makeScrollPane

public abstract java.awt.Container makeScrollPane(java.awt.Component contents)

Returns either a java.awt.ScrollPane of a javax.swing.JScrollPane.

---

getViewportSize

public abstract java.awt.Dimension getViewportSize(java.awt.Container scrollpane)

Returns the viewport size of a scrollpane.

---

getScrollPosition

public abstract java.awt.Point getScrollPosition(java.awt.Container scrollpane)

Returns the scroll position of a scrollpane.

---

setScrollPosition

public abstract void setScrollPosition(java.awt.Container scrollpane,
                                       int x,
                                       int y)

Sets the scroll position of a scrollpane.

---

makeChoice

public abstract java.awt.Component makeChoice(java.lang.String[] items,
                                              java.awt.event.ItemListener itemListener)

Returns either a java.awt.Choice or a javax.swing.JComboBox.

---

setChoiceItems

public abstract void setChoiceItems(java.awt.Component choice,
                                    java.lang.String[] items)

Set the items on a choice.

---

makeList

public abstract java.awt.Component makeList(java.lang.String[] items,
                                            java.awt.event.ItemListener itemListener)

Returns either a java.awt.List or a javax.swing.JList.

---

setListItems

public abstract void setListItems(java.awt.Component list,
                                  java.lang.String[] items)

Set the items on a list.

---

setSelected

public abstract void setSelected(java.awt.Component choice,
                                 java.lang.String item)

Set the currently selected item on a choice.

---

getSelected

public abstract java.lang.String getSelected(java.awt.Component choice)

Get the currently selected item on a choice.

---

getSelectedIndex

public abstract int getSelectedIndex(java.awt.Component choice)

Get the currently selected item on a choice.

---

makeProgressBar

public abstract java.awt.Component makeProgressBar()

Returns either a ProgressBar or a javax.swing.JProgressBar.

---

setProgressBarMax

public abstract void setProgressBarMax(java.awt.Component progressBar,
                                       int max)

Set the max value on a progress bar.

---

setProgressBarValue

public abstract void setProgressBarValue(java.awt.Component progressBar,
                                         int value)

Set the current value of a progress bar.

---

makeTextField

public abstract java.awt.Component makeTextField(java.lang.String text,
                                                 int columns,
                                                 java.awt.event.TextListener listener)

Returns either a java.awt.TextField or a javax.swing.JTextField.

---

setEditable

public abstract void setEditable(java.awt.Component textField,
                                 boolean editable)

---

getText

public abstract java.lang.String getText(java.awt.Component textField)

Get the text from a text field.

---

makeCheckBox

public java.awt.Component makeCheckBox(java.lang.String label,
                                       java.awt.event.ItemListener listener)

Returns either a java.awt.Checkbox or a javax.swing.JCheckBox

---

makeCheckBoxImpl

protected abstract java.awt.Component makeCheckBoxImpl(java.lang.String label,
                                                       java.awt.event.ItemListener listener)

---

getCheckBoxState

public abstract boolean getCheckBoxState(java.awt.Component checkBox)

Get the current state of a CheckBox

---

setCheckBoxState

public abstract void setCheckBoxState(java.awt.Component checkBox,
                                      boolean state)

Set the state of a CheckBox.

---

canChooseFolders

public abstract boolean canChooseFolders()

Under this setup can we create a folder/directory * chooser?

---

chooseFolder

public java.io.File chooseFolder(java.awt.Frame parent,
                                 java.lang.String title)

Display a dialog to allow the user to choose a folder (eg for * where to download files to.

---

chooseFolderImp

protected abstract java.io.File chooseFolderImp(java.awt.Frame parent,
                                                java.lang.String title)

---

chooseSaveFile

public java.io.File chooseSaveFile(java.awt.Frame parent,
                                   java.lang.String title)

Display a dialog to allow the user to save a file.

---

chooseSaveFileImp

protected abstract java.io.File chooseSaveFileImp(java.awt.Frame parent,
                                                  java.lang.String title)

---

chooseOpenFile

public java.io.File chooseOpenFile(java.awt.Frame parent,
                                   java.lang.String title)

Display a dialog to allow the user to open a file.

---

chooseOpenFileImp

protected abstract java.io.File chooseOpenFileImp(java.awt.Frame parent,
                                                  java.lang.String title)

---

centreWindow

public void centreWindow(java.awt.Window parent,
                         java.awt.Window child)

Centre child relative to parent.

---

makeMultiLineLabel

public java.awt.Container makeMultiLineLabel(java.lang.String text)

Make a panel, containing multiple lines of text (as labels). * divided by new lines (\n)

---

doQueryDialog

public boolean doQueryDialog(java.awt.Frame frame,
                             java.lang.String title,
                             java.lang.String query)

Display a simple, yes/no dialog.

---

doMultipleQueryDialog

public java.lang.String doMultipleQueryDialog(java.awt.Frame frame,
                                              java.lang.String title,
                                              java.lang.String query)

A query dialog that may be one of many, hence it has a "yes to all" button, as well as a yes button. * Returns either "yes", "no" or "yes all" depending on button pressed.

---

showMessageDialog

public void showMessageDialog(java.awt.Frame frame,
                              java.lang.String title,
                              java.lang.String msg)

Display a simple dialog with a message and an ok/done button.

---

doTextInputDialog

public java.lang.String doTextInputDialog(java.awt.Frame frame,
                                          java.lang.String title,
                                          java.lang.String msg,
                                          java.lang.String text)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> jpl2 >> common >> [ gui overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---