org.basex.gui.view.editor
Class EditorView

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.basex.gui.layout.BaseXBack
                      extended by org.basex.gui.layout.BaseXPanel
                          extended by org.basex.gui.view.View
                              extended by org.basex.gui.view.editor.EditorView
All Implemented Interfaces:
java.awt.event.ComponentListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public final class EditorView
extends View

This view allows the input and evaluation of queries and documents.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class org.basex.gui.layout.BaseXPanel
gui
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
EditorView(ViewNotifier man)
          Default constructor.
 
Method Summary
 boolean close(org.basex.gui.view.editor.EditorArea edit)
          Closes an editor.
 boolean confirm()
          Shows a quit dialog for all modified query files.
protected  boolean db()
          Tests if this view relies on a database instance.
 void error(java.lang.String msg, boolean jump)
          Handles info messages resulting from a query execution.
 org.basex.gui.view.editor.EditorArea getEditor()
          Returns the current editor.
 void gotoLine()
          Jumps to a specific line.
 void info(java.lang.String msg, boolean ok, boolean refresh)
          Evaluates the info message resulting from a parsed or executed query.
 boolean modified()
          Checks if the current text can be saved or reverted.
 void newFile()
          Creates a new file.
 void open()
          Opens a new file.
 org.basex.gui.view.editor.EditorArea open(IO file, boolean parse)
          Opens the specified query file.
 void refreshContext(boolean more, boolean quick)
          Called when a new context set has been chosen.
 void refreshFocus()
          Called when a new focus has been chosen.
 void refreshInit()
          Called when the data reference has changed.
 void refreshLayout()
          Called when GUI design has changed.
 void refreshMark()
          Called when a context set has been marked.
 void refreshUpdate()
          Called when updates have been done in the data structure.
 void reopen()
          Reverts the contents of the currently opened editor.
 boolean save()
          Saves the contents of the currently opened editor.
 boolean saveAs()
          Saves the contents of the currently opened editor under a new name.
 void start()
          Starts a thread, which shows a waiting info after a short timeout.
 boolean visible()
          Tests if this view is currently marked as visible.
 void visible(boolean v)
          Sets a flag denoting the visibility of the view.
 
Methods inherited from class org.basex.gui.view.View
keyPressed, mouseEntered, mouseExited, mousePressed, toString
 
Methods inherited from class org.basex.gui.layout.BaseXPanel
componentHidden, componentMoved, componentResized, componentShown, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseMoved, mouseReleased, mouseWheelMoved
 
Methods inherited from class org.basex.gui.layout.BaseXBack
border, border, layout, mode, paintComponent, smooth
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EditorView

public EditorView(ViewNotifier man)
Default constructor.

Parameters:
man - view manager
Method Detail

refreshInit

public void refreshInit()
Description copied from class: View
Called when the data reference has changed.

Specified by:
refreshInit in class View

refreshFocus

public void refreshFocus()
Description copied from class: View
Called when a new focus has been chosen.

Specified by:
refreshFocus in class View

refreshMark

public void refreshMark()
Description copied from class: View
Called when a context set has been marked.

Specified by:
refreshMark in class View

refreshContext

public void refreshContext(boolean more,
                           boolean quick)
Description copied from class: View
Called when a new context set has been chosen.

Specified by:
refreshContext in class View
Parameters:
more - show more details
quick - perform a quick context switch

refreshLayout

public void refreshLayout()
Description copied from class: View
Called when GUI design has changed.

Specified by:
refreshLayout in class View

refreshUpdate

public void refreshUpdate()
Description copied from class: View
Called when updates have been done in the data structure.

Specified by:
refreshUpdate in class View

visible

public boolean visible()
Description copied from class: View
Tests if this view is currently marked as visible.

Specified by:
visible in class View
Returns:
result of check

visible

public void visible(boolean v)
Description copied from class: View
Sets a flag denoting the visibility of the view.

Specified by:
visible in class View
Parameters:
v - visibility flag

db

protected boolean db()
Description copied from class: View
Tests if this view relies on a database instance.

Specified by:
db in class View
Returns:
result of check

open

public void open()
Opens a new file.


reopen

public void reopen()
Reverts the contents of the currently opened editor.


save

public boolean save()
Saves the contents of the currently opened editor.

Returns:
false if operation was canceled

saveAs

public boolean saveAs()
Saves the contents of the currently opened editor under a new name.

Returns:
false if operation was canceled

newFile

public void newFile()
Creates a new file.


open

public org.basex.gui.view.editor.EditorArea open(IO file,
                                                 boolean parse)
Opens the specified query file.

Parameters:
file - query file
parse - parse contents
Returns:
opened editor, or null if file could not be opened

close

public boolean close(org.basex.gui.view.editor.EditorArea edit)
Closes an editor.

Parameters:
edit - editor to be closed. null closes the currently opened editor.
Returns:
true if editor was closed

gotoLine

public void gotoLine()
Jumps to a specific line.


start

public void start()
Starts a thread, which shows a waiting info after a short timeout.


info

public void info(java.lang.String msg,
                 boolean ok,
                 boolean refresh)
Evaluates the info message resulting from a parsed or executed query.

Parameters:
msg - info message
ok - true if evaluation was successful
refresh - refresh buttons

error

public void error(java.lang.String msg,
                  boolean jump)
Handles info messages resulting from a query execution.

Parameters:
jump - jump to error position
msg - info message

confirm

public boolean confirm()
Shows a quit dialog for all modified query files.

Returns:
false if confirmation was canceled

modified

public boolean modified()
Checks if the current text can be saved or reverted.

Returns:
result of check

getEditor

public org.basex.gui.view.editor.EditorArea getEditor()
Returns the current editor.

Returns:
editor