Package org.nuiton.jaxx.widgets.extra.editor

Class DefaultEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.nuiton.jaxx.widgets.extra.editor.DefaultEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, EditorInterface

Direct Known Subclasses:

SDocEditor

public class DefaultEditor
extends JPanel
implements EditorInterface, DocumentListener

Default editor, can open of kind of file behaviour:

undo/redo (Ctrl-z, Shift-Ctrl-z) 

Scrollbar

Author:

poussin

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
protected JEditorPane	editor
protected boolean	isModified
protected JScrollPane	scrollPane

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
DefaultEditor()

Method Summary

Modifier and Type	Method	Description
boolean	accept(File file)	If return true, this editor support this file type.
boolean	accept(Editor.EditorSyntaxConstant editorSyntaxConstant)	If return true, this editor support the syntax type.
void	addCaretListener(CaretListener listener)	Add caret listener.
void	addDocumentListener(DocumentListener listener)	Add document listener.
void	changedUpdate(DocumentEvent e)
void	copy()	Copy current current selection into system clipboard.
void	cut()	Cut current editor selection into system clipboard.
String	getText()	Return the current content text of the editor as String.
void	insertUpdate(DocumentEvent e)
boolean	isModified()	Indicate if current opened file has been modified.
boolean	open(File file)	Replace the current edited file by file passed in argument.
void	paste()	Paste current clicboard content into editor at caret position.
void	removeCaretListener(CaretListener listener)	Remove caret listener.
void	removeDocumentListener(DocumentListener listener)	Remove document listener.
void	removeUpdate(DocumentEvent e)
boolean	saveAs(File file)	Replace the current edited file by file passed in argument.
void	setSyntax(Editor.EditorSyntaxConstant editorSyntax)	Force syntax to use
void	setText(String text)	Set all text with text in argument.

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, paintComponent, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuiton.jaxx.widgets.extra.editor.EditorInterface

setEnabled

Field Detail

editor

protected JEditorPane editor

scrollPane

protected JScrollPane scrollPane

isModified

protected boolean isModified

Constructor Detail

DefaultEditor

public DefaultEditor()

Method Detail

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Description copied from interface: EditorInterface

Add document listener.

Specified by:

addDocumentListener in interface EditorInterface

Parameters:

listener - listener

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Description copied from interface: EditorInterface

Remove document listener.

Specified by:

removeDocumentListener in interface EditorInterface

Parameters:

listener - listener

addCaretListener

public void addCaretListener(CaretListener listener)

Description copied from interface: EditorInterface

Add caret listener.

Specified by:

addCaretListener in interface EditorInterface

Parameters:

listener - listener

removeCaretListener

public void removeCaretListener(CaretListener listener)

Description copied from interface: EditorInterface

Remove caret listener.

Specified by:

removeCaretListener in interface EditorInterface

Parameters:

listener - listener

accept

public boolean accept(File file)

Description copied from interface: EditorInterface

If return true, this editor support this file type. Default implementation return true.

Specified by:

accept in interface EditorInterface

Parameters:

file - file to test

Returns:

if return true, this editor support this file type.

accept

public boolean accept(Editor.EditorSyntaxConstant editorSyntaxConstant)

Description copied from interface: EditorInterface

If return true, this editor support the syntax type. Default implementation return true.

Specified by:

accept in interface EditorInterface

Parameters:

editorSyntaxConstant - syntaxe type to test

Returns:

if return true, this editor support this syntax type.

isModified

public boolean isModified()

Description copied from interface: EditorInterface

Indicate if current opened file has been modified.

Specified by:

isModified in interface EditorInterface

Returns:

true if current file is modified

setSyntax

public void setSyntax(Editor.EditorSyntaxConstant editorSyntax)

Description copied from interface: EditorInterface

Force syntax to use

Specified by:

setSyntax in interface EditorInterface

Parameters:

editorSyntax - to use

open

public boolean open(File file)

Description copied from interface: EditorInterface

Replace the current edited file by file passed in argument.

Specified by:

open in interface EditorInterface

Parameters:

file - the file to open

Returns:

true if file has been opened

saveAs

public boolean saveAs(File file)

Description copied from interface: EditorInterface

Replace the current edited file by file passed in argument.

Specified by:

saveAs in interface EditorInterface

Parameters:

file - the file to open

Returns:

true if file has been saved and reopen with new name

getText

public String getText()

Description copied from interface: EditorInterface

Return the current content text of the editor as String.

Specified by:

getText in interface EditorInterface

Returns:

return the current content text of the editor as String

setText

public void setText(String text)

Description copied from interface: EditorInterface

Set all text with text in argument.

Specified by:

setText in interface EditorInterface

Parameters:

text - test to set

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

copy

public void copy()

Description copied from interface: EditorInterface

Copy current current selection into system clipboard.

Specified by:

copy in interface EditorInterface

cut

public void cut()

Description copied from interface: EditorInterface

Cut current editor selection into system clipboard.

Specified by:

cut in interface EditorInterface

paste

public void paste()

Description copied from interface: EditorInterface

Paste current clicboard content into editor at caret position.

Specified by:

paste in interface EditorInterface