Package org.basex.gui.view.editor

Class EditorView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.basex.gui.layout.BaseXBack

org.basex.gui.layout.BaseXPanel

org.basex.gui.view.View

org.basex.gui.view.editor.EditorView

All Implemented Interfaces:

ComponentListener, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public final class EditorView
extends View

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

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
GUICode	posCode	Code for setting cursor position.

Fields inherited from class org.basex.gui.layout.BaseXPanel

gui

Fields inherited from class org.basex.gui.layout.BaseXBack

SEPARATOR_SIZE

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor	Description
EditorView(ViewNotifier notifier)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	close(EditorArea edit)	Closes an editor.
void	closeAll()	Closes all editors.
boolean	confirm(EditorArea edit)	Shows a confirmation dialog for the specified editor, or all editors.
String	context()	Returns a string describing the current context.
protected boolean	db()	Tests if this view relies on a database instance.
boolean	delete(IOFile file)	Deletes a file.
void	findFiles()	Focuses the project view.
void	focusEditor()	Focuses the current editor.
EditorArea	getEditor()	Returns the current editor.
void	historyPopup(int start)	Shows a history popup menu.
void	info(Throwable th, boolean stopped, boolean refresh)	Processes the result from a command or query execution.
void	init(ArrayList<IOFile> files)	Opens previously opened and new files.
void	jump(String link)	Jumps to the specified file and position.
void	jumpToFile()	Focuses the currently edited file in the project view.
void	markError(boolean jump)	Jumps to the current error.
void	newFile()	Creates a new file.
void	open()	Opens a new file.
EditorArea	open(IOFile file)	Opens and parses the specified query file.
String[]	openFiles()	Returns paths of all open files.
void	pleaseWait(int id)	Starts a thread, which shows a waiting info after a short timeout.
void	refreshContext(boolean more, boolean quick)	Called when a new context set has been chosen.
void	refreshContextLabel()	Refreshes the context label.
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	rename(IOFile old, IOFile renamed)	Updates the references to renamed files.
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	setContext(IOFile file)	Sets an XML document as context.
void	showProject()	Shows the project view.
void	tab(boolean next)	Switches the current editor tab.
void	toggleProject()	Toggles the project view.
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, paintComponent

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

Field Detail

posCode

public final GUICode posCode

Code for setting cursor position.

Constructor Detail

EditorView

public EditorView(ViewNotifier notifier)

Default constructor.

Parameters:

notifier - view notifier

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

historyPopup

public void historyPopup(int start)

Shows a history popup menu.

Parameters:

start - first entry

refreshContextLabel

public void refreshContextLabel()

Refreshes the context label.

setContext

public void setContext(IOFile file)

Sets an XML document as context.

Parameters:

file - file

context

public String context()

Returns a string describing the current context.

Returns:

context string (can be empty)

showProject

public void showProject()

Shows the project view.

toggleProject

public void toggleProject()

Toggles the project view.

findFiles

public void findFiles()

Focuses the project view.

focusEditor

public void focusEditor()

Focuses the current editor.

jumpToFile

public void jumpToFile()

Focuses the currently edited file in the project view.

tab

public void tab(boolean next)

Switches the current editor tab.

Parameters:

next - next next/previous tab

init

public void init(ArrayList<IOFile> files)

Opens previously opened and new files.

Parameters:

files - files to be opened

open

public void open()

Opens a new file.

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.

delete

public boolean delete(IOFile file)

Deletes a file.

Parameters:

file - file to be deleted

Returns:

success flag

open

public EditorArea open(IOFile file)

Opens and parses the specified query file.

Parameters:

file - query file

Returns:

opened editor or null if file could not be opened

closeAll

public void closeAll()

Closes all editors.

close

public void close(EditorArea edit)

Closes an editor.

Parameters:

edit - editor to be closed (if null, the currently opened editor will be closed)

pleaseWait

public void pleaseWait(int id)

Starts a thread, which shows a waiting info after a short timeout.

Parameters:

id - thread id

info

public void info(Throwable th,
                 boolean stopped,
                 boolean refresh)

Processes the result from a command or query execution.

Parameters:

th - exception or null

stopped - true if evaluation was stopped

refresh - refresh buttons

jump

public void jump(String link)

Jumps to the specified file and position.

Parameters:

link - link

markError

public void markError(boolean jump)

Jumps to the current error.

Parameters:

jump - jump to error position (if necessary, open file)

openFiles

public String[] openFiles()

Returns paths of all open files.

Returns:

file paths

getEditor

public EditorArea getEditor()

Returns the current editor.

Returns:

editor or null

rename

public void rename(IOFile old,
                   IOFile renamed)

Updates the references to renamed files.

Parameters:

old - old file reference

renamed - updated file reference

confirm

public boolean confirm(EditorArea edit)

Shows a confirmation dialog for the specified editor, or all editors.

Parameters:

edit - editor to be saved, or null to save all editors

Returns:

true if all editors were confirmed