org.basex.gui
Class GUI

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by org.basex.gui.GUI
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public final class GUI
extends javax.swing.JFrame

This class is the main window of the GUI. It is the central instance for user interactions.

Author:
Workgroup DBIS, University of Konstanz 2005-08, ISC License, Christian Gruen
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
 
Field Summary
static Context context
          Database Context.
 BaseXButton filter
          Filter button.
 TextView help
          Help view.
 BaseXButton hist
          History button.
 InfoView info
          Info view.
 GUIInput input
          Input field.
 QueryView query
          Search view.
 GUIStatus status
          Status line.
 TextView text
          Text view.
 ViewContainer views
          Content panel, containing all views.
 
Fields inherited from class javax.swing.JFrame
EXIT_ON_CLOSE
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Method Summary
 void checkFocus(javax.swing.JComponent comp)
          Focuses the specified component if the input field is not focused.
 void checkKeys(java.awt.event.KeyEvent e)
          Browse in views.
 void cursor(java.awt.Cursor c)
          Sets a cursor.
 void cursor(java.awt.Cursor c, boolean force)
          Sets a cursor, forcing a new look if necessary.
 boolean exec(Process pr)
          Launches the specified process.
 void execute(Process pr)
          Launches the specified process in a thread.
 void focus(java.awt.Component comp, byte[] txt)
          Displays some help in the help view.
 void fullscreen()
          Turns fullscreen mode on/off.
 void fullscreen(boolean full)
          Turns fullscreen mode on/off.
static GUI get()
          Singleton Constructor.
static javax.swing.ImageIcon icon(java.lang.String name)
          Returns the specified image as icon.
static java.awt.Image image(java.lang.String name)
          Returns the specified image.
static java.net.URL imageURL(java.lang.String name)
          Returns the image url.
 void layoutViews()
          Updates the view layout.
 void refreshControls()
          Refreshes the menu and the buttons.
 void setHits(int n)
          Sets hits information.
 void stop()
          Stops the current process.
 void updateLayout()
          Refreshes the layout.
 
Methods inherited from class javax.swing.JFrame
getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update
 
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

context

public static Context context
Database Context.


status

public final GUIStatus status
Status line.


views

public final ViewContainer views
Content panel, containing all views.


input

public final GUIInput input
Input field.


filter

public final BaseXButton filter
Filter button.


hist

public final BaseXButton hist
History button.


query

public final QueryView query
Search view.


text

public final TextView text
Text view.


info

public final InfoView info
Info view.


help

public final TextView help
Help view.

Method Detail

get

public static GUI get()
Singleton Constructor.

Returns:
window reference

checkKeys

public void checkKeys(java.awt.event.KeyEvent e)
Browse in views.

Parameters:
e - key event

cursor

public void cursor(java.awt.Cursor c)
Sets a cursor.

Parameters:
c - cursor to be set

cursor

public void cursor(java.awt.Cursor c,
                   boolean force)
Sets a cursor, forcing a new look if necessary.

Parameters:
c - cursor to be set
force - new cursor

execute

public void execute(Process pr)
Launches the specified process in a thread.

Parameters:
pr - process to be launched

stop

public void stop()
Stops the current process.


exec

public boolean exec(Process pr)
Launches the specified process.

Parameters:
pr - process to be launched
Returns:
success flag

updateLayout

public void updateLayout()
Refreshes the layout.


layoutViews

public void layoutViews()
Updates the view layout.


refreshControls

public void refreshControls()
Refreshes the menu and the buttons.


setHits

public void setHits(int n)
Sets hits information.

Parameters:
n - number of hits

checkFocus

public void checkFocus(javax.swing.JComponent comp)
Focuses the specified component if the input field is not focused.

Parameters:
comp - component to be focused

focus

public void focus(java.awt.Component comp,
                  byte[] txt)
Displays some help in the help view.

Parameters:
comp - component reference
txt - text to be shown

icon

public static javax.swing.ImageIcon icon(java.lang.String name)
Returns the specified image as icon.

Parameters:
name - name of icon
Returns:
icon

image

public static java.awt.Image image(java.lang.String name)
Returns the specified image.

Parameters:
name - name of image
Returns:
image

imageURL

public static java.net.URL imageURL(java.lang.String name)
Returns the image url.

Parameters:
name - name of image
Returns:
url

fullscreen

public void fullscreen()
Turns fullscreen mode on/off.


fullscreen

public void fullscreen(boolean full)
Turns fullscreen mode on/off.

Parameters:
full - fullscreen mode