Dave Jarvis' Repositories
git clone https://repo.autonoma.ca/repo/keenwrite.git
Upgraded to RichTextFX v0.7-M3. Partially working line numbers. Fixed bug with pressing Enter at end of edit panel. Added source code comments.
| Author | djarvis <email> |
|---|---|
| Date | 2017-01-02 22:46:54 GMT-0800 |
| Commit | 460a7bb3c8a3f84d68e1a0de902ead93381585ec |
| Parent | 5d2bac1 |
| Delta | 568 lines added, 529 lines removed, 39-line increase |
src/main/resources/com/scrivenvar/messages.properties
| # ######################################################################## | ||
| # | ||
| +# Status Bar | ||
| +# | ||
| +# ######################################################################## | ||
| + | ||
| +Main.statusbar.line=Line {0} of {1} | ||
| +Main.statusbar.state.default=OK | ||
| + | ||
| +# ######################################################################## | ||
| +# | ||
| # About Dialog | ||
| # |
src/main/java/com/scrivenvar/FileEditorTab.java
| import javafx.stage.Window; | ||
| import org.fxmisc.richtext.StyleClassedTextArea; | ||
| +import static org.fxmisc.richtext.model.TwoDimensional.Bias.Forward; | ||
| +import org.fxmisc.richtext.model.TwoDimensional.Position; | ||
| import org.fxmisc.undo.UndoManager; | ||
| import org.fxmisc.wellbehaved.event.EventPattern; | ||
 | ||
| public final class FileEditorTab extends Tab { | ||
| - private final Notifier alertService = Services.load(Notifier.class ); | ||
| + private final Notifier alertService = Services.load( Notifier.class ); | ||
| private EditorPane editorPane; | ||
| ||
| public int getCaretPosition() { | ||
| return getEditor().getCaretPosition(); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Returns the caret's current row and column position. | ||
| + * | ||
| + * @return The caret's offset into the document. | ||
| + */ | ||
| + public Position getCaretOffset() { | ||
| + return getEditor().offsetToPosition( getCaretPosition(), Forward ); | ||
| } | ||
src/main/java/com/scrivenvar/MainWindow.java
| import static javafx.stage.WindowEvent.WINDOW_CLOSE_REQUEST; | ||
| import org.controlsfx.control.StatusBar; | ||
| - | ||
| -/** | ||
| - * Main window containing a tab pane in the center for file editors. | ||
| - * | ||
| - * @author Karl Tauber and White Magic Software, Ltd. | ||
| - */ | ||
| -public class MainWindow implements Observer { | ||
| - | ||
| - private final Options options = Services.load( Options.class ); | ||
| - private final Snitch snitch = Services.load( Snitch.class ); | ||
| - private final Notifier notifier = Services.load( Notifier.class ); | ||
| - | ||
| - private Scene scene; | ||
| - private MenuBar menuBar; | ||
| - private StatusBar statusBar; | ||
| - | ||
| - private DefinitionSource definitionSource; | ||
| - private DefinitionPane definitionPane; | ||
| - private FileEditorTabPane fileEditorPane; | ||
| - private HTMLPreviewPane previewPane; | ||
| - | ||
| - /** | ||
| - * Prevent re-instantiation processing classes. | ||
| - */ | ||
| - private Map<FileEditorTab, Processor<String>> processors; | ||
| - | ||
| - public MainWindow() { | ||
| - initLayout(); | ||
| - initDefinitionListener(); | ||
| - initTabAddedListener(); | ||
| - initTabChangedListener(); | ||
| - initPreferences(); | ||
| - initSnitch(); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Listen for file editor tab pane to receive an open definition source event. | ||
| - */ | ||
| - private void initDefinitionListener() { | ||
| - getFileEditorPane().onOpenDefinitionFileProperty().addListener( | ||
| - (ObservableValue<? extends Path> definitionFile, | ||
| - final Path oldPath, final Path newPath) -> { | ||
| - openDefinition( newPath ); | ||
| - | ||
| - // Indirectly refresh the resolved map. | ||
| - setProcessors( null ); | ||
| - | ||
| - // Will create new processors and therefore a new resolved map. | ||
| - refreshSelectedTab( getActiveFileEditor() ); | ||
| - | ||
| - updateDefinitionPane(); | ||
| - } | ||
| - ); | ||
| - } | ||
| - | ||
| - /** | ||
| - * When tabs are added, hook the various change listeners onto the new tab so | ||
| - * that the preview pane refreshes as necessary. | ||
| - */ | ||
| - private void initTabAddedListener() { | ||
| - final FileEditorTabPane editorPane = getFileEditorPane(); | ||
| - | ||
| - // Make sure the text processor kicks off when new files are opened. | ||
| - final ObservableList<Tab> tabs = editorPane.getTabs(); | ||
| - | ||
| - // Update the preview pane on tab changes. | ||
| - tabs.addListener( | ||
| - (final Change<? extends Tab> change) -> { | ||
| - while( change.next() ) { | ||
| - if( change.wasAdded() ) { | ||
| - // Multiple tabs can be added simultaneously. | ||
| - for( final Tab newTab : change.getAddedSubList() ) { | ||
| - final FileEditorTab tab = (FileEditorTab)newTab; | ||
| - | ||
| - initTextChangeListener( tab ); | ||
| - initCaretParagraphListener( tab ); | ||
| - initVariableNameInjector( tab ); | ||
| -// initSyntaxListener( tab ); | ||
| - } | ||
| - } | ||
| - } | ||
| - } | ||
| - ); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Reloads the preferences from the previous load. | ||
| - */ | ||
| - private void initPreferences() { | ||
| - restoreDefinitionSource(); | ||
| - getFileEditorPane().restorePreferences(); | ||
| - updateDefinitionPane(); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Listen for new tab selection events. | ||
| - */ | ||
| - private void initTabChangedListener() { | ||
| - final FileEditorTabPane editorPane = getFileEditorPane(); | ||
| - | ||
| - // Update the preview pane changing tabs. | ||
| - editorPane.addTabSelectionListener( | ||
| - (ObservableValue<? extends Tab> tabPane, | ||
| - final Tab oldTab, final Tab newTab) -> { | ||
| - | ||
| - // If there was no old tab, then this is a first time load, which | ||
| - // can be ignored. | ||
| - if( oldTab != null ) { | ||
| - if( newTab == null ) { | ||
| - closeRemainingTab(); | ||
| - } | ||
| - else { | ||
| - // Update the preview with the edited text. | ||
| - refreshSelectedTab( (FileEditorTab)newTab ); | ||
| - } | ||
| - } | ||
| - } | ||
| - ); | ||
| - } | ||
| - | ||
| - private void initTextChangeListener( final FileEditorTab tab ) { | ||
| - tab.addTextChangeListener( | ||
| - (ObservableValue<? extends String> editor, | ||
| - final String oldValue, final String newValue) -> { | ||
| - refreshSelectedTab( tab ); | ||
| - } | ||
| - ); | ||
| - } | ||
| - | ||
| - private void initCaretParagraphListener( final FileEditorTab tab ) { | ||
| - tab.addCaretParagraphListener( | ||
| - (ObservableValue<? extends Integer> editor, | ||
| - final Integer oldValue, final Integer newValue) -> { | ||
| - refreshSelectedTab( tab ); | ||
| - } | ||
| - ); | ||
| - } | ||
| - | ||
| - private void initVariableNameInjector( final FileEditorTab tab ) { | ||
| - VariableNameInjector.listen( tab, getDefinitionPane() ); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Watch for changes to external files. In particular, this awaits | ||
| - * modifications to any XSL files associated with XML files being edited. When | ||
| - * an XSL file is modified (external to the application), the snitch's ears | ||
| - * perk up and the file is reloaded. This keeps the XSL transformation up to | ||
| - * date with what's on the file system. | ||
| - */ | ||
| - private void initSnitch() { | ||
| - getSnitch().addObserver( this ); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Called whenever the preview pane becomes out of sync with the file editor | ||
| - * tab. This can be called when the text changes, the caret paragraph changes, | ||
| - * or the file tab changes. | ||
| - * | ||
| - * @param tab The file editor tab that has been changed in some fashion. | ||
| - */ | ||
| - private void refreshSelectedTab( final FileEditorTab tab ) { | ||
| - if( tab.isFileOpen() ) { | ||
| - getPreviewPane().setPath( tab.getPath() ); | ||
| - | ||
| - Processor<String> processor = getProcessors().get( tab ); | ||
| - | ||
| - if( processor == null ) { | ||
| - processor = createProcessor( tab ); | ||
| - getProcessors().put( tab, processor ); | ||
| - } | ||
| - | ||
| - try { | ||
| - processor.processChain( tab.getEditorText() ); | ||
| - getNotifier().clear(); | ||
| - } catch( final Exception ex ) { | ||
| - error( ex ); | ||
| - } | ||
| - } | ||
| - } | ||
| - | ||
| - /** | ||
| - * Returns the variable map of interpolated definitions. | ||
| - * | ||
| - * @return A map to help dereference variables. | ||
| - */ | ||
| - private Map<String, String> getResolvedMap() { | ||
| - return getDefinitionSource().getResolvedMap(); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Returns the root node for the hierarchical definition source. | ||
| - * | ||
| - * @return Data to display in the definition pane. | ||
| - */ | ||
| - private TreeView<String> getTreeView() { | ||
| - try { | ||
| - return getDefinitionSource().asTreeView(); | ||
| - } catch( Exception e ) { | ||
| - error( e ); | ||
| - } | ||
| - | ||
| - return new TreeView<>(); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Called when a definition source is opened. | ||
| - * | ||
| - * @param path Path to the definition source that was opened. | ||
| - */ | ||
| - private void openDefinition( final Path path ) { | ||
| - try { | ||
| - final DefinitionSource ds = createDefinitionSource( path.toString() ); | ||
| - setDefinitionSource( ds ); | ||
| - storeDefinitionSource(); | ||
| - updateDefinitionPane(); | ||
| - } catch( final Exception e ) { | ||
| - error( e ); | ||
| - } | ||
| - } | ||
| - | ||
| - private void updateDefinitionPane() { | ||
| - getDefinitionPane().setRoot( getDefinitionSource().asTreeView() ); | ||
| - } | ||
| - | ||
| - private void restoreDefinitionSource() { | ||
| - final Preferences preferences = getPreferences(); | ||
| - final String source = preferences.get( PREFS_DEFINITION_SOURCE, null ); | ||
| - | ||
| - // If there's no definition source set, don't try to load it. | ||
| - if( source != null ) { | ||
| - setDefinitionSource( createDefinitionSource( source ) ); | ||
| - } | ||
| - } | ||
| - | ||
| - private void storeDefinitionSource() { | ||
| - final Preferences preferences = getPreferences(); | ||
| - final DefinitionSource ds = getDefinitionSource(); | ||
| - | ||
| - preferences.put( PREFS_DEFINITION_SOURCE, ds.toString() ); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Called when the last open tab is closed to clear the preview pane. | ||
| - */ | ||
| - private void closeRemainingTab() { | ||
| - getPreviewPane().clear(); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Called when an exception occurs that warrants the user's attention. | ||
| - * | ||
| - * @param e The exception with a message that the user should know about. | ||
| - */ | ||
| - private void error( final Exception e ) { | ||
| - getNotifier().notify( e ); | ||
| - } | ||
| - | ||
| - //---- File actions ------------------------------------------------------- | ||
| - /** | ||
| - * Called when an observable instance has changed. This includes the snitch | ||
| - * service and the notify service. | ||
| - * | ||
| - * @param observable The observed instance. | ||
| - * @param value The noteworthy item. | ||
| - */ | ||
| - @Override | ||
| - public void update( final Observable observable, final Object value ) { | ||
| - if( value != null ) { | ||
| - if( observable instanceof Snitch && value instanceof Path ) { | ||
| - update( (Path)value ); | ||
| - } | ||
| - else if( observable instanceof Notifier && value instanceof String ) { | ||
| - final String s = (String)value; | ||
| - final int index = s.indexOf( '\n' ); | ||
| - final String message = s.substring( 0, index > 0 ? index : s.length() ); | ||
| - | ||
| - getStatusBar().setText( message ); | ||
| - } | ||
| - } | ||
| - } | ||
| - | ||
| - /** | ||
| - * Called when a file has been modified. | ||
| - * | ||
| - * @param file Path to the modified file. | ||
| - */ | ||
| - private void update( final Path file ) { | ||
| - // Avoid throwing IllegalStateException by running from a non-JavaFX thread. | ||
| - Platform.runLater( | ||
| - () -> { | ||
| - // Brute-force XSLT file reload by re-instantiating all processors. | ||
| - resetProcessors(); | ||
| - refreshSelectedTab( getActiveFileEditor() ); | ||
| - } | ||
| - ); | ||
| - } | ||
| - | ||
| - /** | ||
| - * After resetting the processors, they will refresh anew to be up-to-date | ||
| - * with the files (text and definition) currently loaded into the editor. | ||
| - */ | ||
| - private void resetProcessors() { | ||
| - getProcessors().clear(); | ||
| - } | ||
| - | ||
| - //---- File actions ------------------------------------------------------- | ||
| - private void fileNew() { | ||
| - getFileEditorPane().newEditor(); | ||
| - } | ||
| - | ||
| - private void fileOpen() { | ||
| - getFileEditorPane().openFileDialog(); | ||
| - } | ||
| - | ||
| - private void fileClose() { | ||
| - getFileEditorPane().closeEditor( getActiveFileEditor(), true ); | ||
| - } | ||
| - | ||
| - private void fileCloseAll() { | ||
| - getFileEditorPane().closeAllEditors(); | ||
| - } | ||
| - | ||
| - private void fileSave() { | ||
| - getFileEditorPane().saveEditor( getActiveFileEditor() ); | ||
| - } | ||
| - | ||
| - private void fileSaveAll() { | ||
| - getFileEditorPane().saveAllEditors(); | ||
| - } | ||
| - | ||
| - private void fileExit() { | ||
| - final Window window = getWindow(); | ||
| - fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) ); | ||
| - } | ||
| - | ||
| - //---- Help actions ------------------------------------------------------- | ||
| - private void helpAbout() { | ||
| - Alert alert = new Alert( AlertType.INFORMATION ); | ||
| - alert.setTitle( get( "Dialog.about.title" ) ); | ||
| - alert.setHeaderText( get( "Dialog.about.header" ) ); | ||
| - alert.setContentText( get( "Dialog.about.content" ) ); | ||
| - alert.setGraphic( new ImageView( new Image( FILE_LOGO_32 ) ) ); | ||
| - alert.initOwner( getWindow() ); | ||
| - | ||
| - alert.showAndWait(); | ||
| - } | ||
| - | ||
| - //---- Convenience accessors ---------------------------------------------- | ||
| - private float getFloat( final String key, final float defaultValue ) { | ||
| - return getPreferences().getFloat( key, defaultValue ); | ||
| - } | ||
| - | ||
| - private Preferences getPreferences() { | ||
| - return getOptions().getState(); | ||
| - } | ||
| - | ||
| - protected Scene getScene() { | ||
| - if( this.scene == null ) { | ||
| - this.scene = createScene(); | ||
| - } | ||
| - | ||
| - return this.scene; | ||
| - } | ||
| - | ||
| - public Window getWindow() { | ||
| - return getScene().getWindow(); | ||
| - } | ||
| - | ||
| - private MarkdownEditorPane getActiveEditor() { | ||
| - final EditorPane pane = getActiveFileEditor().getEditorPane(); | ||
| - | ||
| - return pane instanceof MarkdownEditorPane ? (MarkdownEditorPane)pane : null; | ||
| - } | ||
| - | ||
| - private FileEditorTab getActiveFileEditor() { | ||
| - return getFileEditorPane().getActiveFileEditor(); | ||
| - } | ||
| - | ||
| - //---- Member accessors --------------------------------------------------- | ||
| - private void setScene( Scene scene ) { | ||
| - this.scene = scene; | ||
| - } | ||
| - | ||
| - private void setProcessors( final Map<FileEditorTab, Processor<String>> map ) { | ||
| - this.processors = map; | ||
| - } | ||
| - | ||
| - private Map<FileEditorTab, Processor<String>> getProcessors() { | ||
| - if( this.processors == null ) { | ||
| - setProcessors( new HashMap<>() ); | ||
| - } | ||
| - | ||
| - return this.processors; | ||
| - } | ||
| - | ||
| - private FileEditorTabPane getFileEditorPane() { | ||
| - if( this.fileEditorPane == null ) { | ||
| - this.fileEditorPane = createFileEditorPane(); | ||
| - } | ||
| - | ||
| - return this.fileEditorPane; | ||
| - } | ||
| - | ||
| - private HTMLPreviewPane getPreviewPane() { | ||
| - if( this.previewPane == null ) { | ||
| - this.previewPane = createPreviewPane(); | ||
| - } | ||
| - | ||
| - return this.previewPane; | ||
| - } | ||
| - | ||
| - private void setDefinitionSource( final DefinitionSource definitionSource ) { | ||
| - this.definitionSource = definitionSource; | ||
| - } | ||
| - | ||
| - private DefinitionSource getDefinitionSource() { | ||
| - if( this.definitionSource == null ) { | ||
| - this.definitionSource = new EmptyDefinitionSource(); | ||
| - } | ||
| - | ||
| - return this.definitionSource; | ||
| - } | ||
| - | ||
| - private DefinitionPane getDefinitionPane() { | ||
| - if( this.definitionPane == null ) { | ||
| - this.definitionPane = createDefinitionPane(); | ||
| - } | ||
| - | ||
| - return this.definitionPane; | ||
| - } | ||
| - | ||
| - private Options getOptions() { | ||
| - return this.options; | ||
| - } | ||
| - | ||
| - private Snitch getSnitch() { | ||
| - return this.snitch; | ||
| - } | ||
| - | ||
| - private Notifier getNotifier() { | ||
| - return this.notifier; | ||
| - } | ||
| - | ||
| - public void setMenuBar( final MenuBar menuBar ) { | ||
| - this.menuBar = menuBar; | ||
| - } | ||
| - | ||
| - public MenuBar getMenuBar() { | ||
| - return this.menuBar; | ||
| - } | ||
| - | ||
| - private synchronized StatusBar getStatusBar() { | ||
| - if( this.statusBar == null ) { | ||
| - this.statusBar = createStatusBar(); | ||
| - } | ||
| - | ||
| - return this.statusBar; | ||
| - } | ||
| - | ||
| - //---- Member creators ---------------------------------------------------- | ||
| - /** | ||
| - * Factory to create processors that are suited to different file types. | ||
| - * | ||
| - * @param tab The tab that is subjected to processing. | ||
| - * | ||
| - * @return A processor suited to the file type specified by the tab's path. | ||
| - */ | ||
| - private Processor<String> createProcessor( final FileEditorTab tab ) { | ||
| - return createProcessorFactory().createProcessor( tab ); | ||
| - } | ||
| - | ||
| - private ProcessorFactory createProcessorFactory() { | ||
| - return new ProcessorFactory( getPreviewPane(), getResolvedMap() ); | ||
| - } | ||
| - | ||
| - private DefinitionSource createDefinitionSource( final String path ) { | ||
| - return createDefinitionFactory().createDefinitionSource( path ); | ||
| - } | ||
| - | ||
| - /** | ||
| - * Create an editor pane to hold file editor tabs. | ||
| - * | ||
| - * @return A new instance, never null. | ||
| - */ | ||
| - private FileEditorTabPane createFileEditorPane() { | ||
| - return new FileEditorTabPane(); | ||
| - } | ||
| - | ||
| - private HTMLPreviewPane createPreviewPane() { | ||
| - return new HTMLPreviewPane(); | ||
| - } | ||
| - | ||
| - private DefinitionPane createDefinitionPane() { | ||
| - return new DefinitionPane( getTreeView() ); | ||
| - } | ||
| - | ||
| - private DefinitionFactory createDefinitionFactory() { | ||
| - return new DefinitionFactory(); | ||
| - } | ||
| - | ||
| - private StatusBar createStatusBar() { | ||
| - return new StatusBar(); | ||
| - } | ||
| - | ||
| - private Scene createScene() { | ||
| - final SplitPane splitPane = new SplitPane( | ||
| - getDefinitionPane().getNode(), | ||
| - getFileEditorPane().getNode(), | ||
| - getPreviewPane().getNode() ); | ||
| - | ||
| - splitPane.setDividerPositions( | ||
| - getFloat( K_PANE_SPLIT_DEFINITION, .10f ), | ||
| - getFloat( K_PANE_SPLIT_EDITOR, .45f ), | ||
| - getFloat( K_PANE_SPLIT_PREVIEW, .45f ) ); | ||
| - | ||
| - // See: http://broadlyapplicable.blogspot.ca/2015/03/javafx-capture-restorePreferences-splitpane.html | ||
| - final BorderPane borderPane = new BorderPane(); | ||
| - borderPane.setPrefSize( 1024, 800 ); | ||
| - borderPane.setTop( createMenuBar() ); | ||
| - borderPane.setBottom( getStatusBar() ); | ||
| - borderPane.setCenter( splitPane ); | ||
| - | ||
| - final VBox box = new VBox(); | ||
| - box.setAlignment( Pos.BASELINE_CENTER ); | ||
| - box.getChildren().add( new Text( "Line %d of %d" ) ); | ||
| - getStatusBar().getRightItems().add( box ); | ||
| - | ||
| - return new Scene( borderPane ); | ||
| +import org.fxmisc.richtext.model.TwoDimensional.Position; | ||
| + | ||
| +/** | ||
| + * Main window containing a tab pane in the center for file editors. | ||
| + * | ||
| + * @author Karl Tauber and White Magic Software, Ltd. | ||
| + */ | ||
| +public class MainWindow implements Observer { | ||
| + | ||
| + private final Options options = Services.load( Options.class ); | ||
| + private final Snitch snitch = Services.load( Snitch.class ); | ||
| + private final Notifier notifier = Services.load( Notifier.class ); | ||
| + | ||
| + private Scene scene; | ||
| + private MenuBar menuBar; | ||
| + private StatusBar statusBar; | ||
| + private Text lineNumberText; | ||
| + | ||
| + private DefinitionSource definitionSource; | ||
| + private DefinitionPane definitionPane; | ||
| + private FileEditorTabPane fileEditorPane; | ||
| + private HTMLPreviewPane previewPane; | ||
| + | ||
| + /** | ||
| + * Prevent re-instantiation processing classes. | ||
| + */ | ||
| + private Map<FileEditorTab, Processor<String>> processors; | ||
| + | ||
| + public MainWindow() { | ||
| + initLayout(); | ||
| + initDefinitionListener(); | ||
| + initTabAddedListener(); | ||
| + initTabChangedListener(); | ||
| + initPreferences(); | ||
| + initSnitch(); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Listen for file editor tab pane to receive an open definition source event. | ||
| + */ | ||
| + private void initDefinitionListener() { | ||
| + getFileEditorPane().onOpenDefinitionFileProperty().addListener( | ||
| + (ObservableValue<? extends Path> definitionFile, | ||
| + final Path oldPath, final Path newPath) -> { | ||
| + openDefinition( newPath ); | ||
| + | ||
| + // Indirectly refresh the resolved map. | ||
| + setProcessors( null ); | ||
| + | ||
| + // Will create new processors and therefore a new resolved map. | ||
| + refreshSelectedTab( getActiveFileEditor() ); | ||
| + updateDefinitionPane(); | ||
| + } | ||
| + ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * When tabs are added, hook the various change listeners onto the new tab so | ||
| + * that the preview pane refreshes as necessary. | ||
| + */ | ||
| + private void initTabAddedListener() { | ||
| + final FileEditorTabPane editorPane = getFileEditorPane(); | ||
| + | ||
| + // Make sure the text processor kicks off when new files are opened. | ||
| + final ObservableList<Tab> tabs = editorPane.getTabs(); | ||
| + | ||
| + // Update the preview pane on tab changes. | ||
| + tabs.addListener( | ||
| + (final Change<? extends Tab> change) -> { | ||
| + while( change.next() ) { | ||
| + if( change.wasAdded() ) { | ||
| + // Multiple tabs can be added simultaneously. | ||
| + for( final Tab newTab : change.getAddedSubList() ) { | ||
| + final FileEditorTab tab = (FileEditorTab)newTab; | ||
| + | ||
| + initTextChangeListener( tab ); | ||
| + initCaretParagraphListener( tab ); | ||
| + initVariableNameInjector( tab ); | ||
| +// initSyntaxListener( tab ); | ||
| + } | ||
| + } | ||
| + } | ||
| + } | ||
| + ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Reloads the preferences from the previous load. | ||
| + */ | ||
| + private void initPreferences() { | ||
| + restoreDefinitionSource(); | ||
| + getFileEditorPane().restorePreferences(); | ||
| + updateDefinitionPane(); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Listen for new tab selection events. | ||
| + */ | ||
| + private void initTabChangedListener() { | ||
| + final FileEditorTabPane editorPane = getFileEditorPane(); | ||
| + | ||
| + // Update the preview pane changing tabs. | ||
| + editorPane.addTabSelectionListener( | ||
| + (ObservableValue<? extends Tab> tabPane, | ||
| + final Tab oldTab, final Tab newTab) -> { | ||
| + | ||
| + // If there was no old tab, then this is a first time load, which | ||
| + // can be ignored. | ||
| + if( oldTab != null ) { | ||
| + if( newTab == null ) { | ||
| + closeRemainingTab(); | ||
| + } | ||
| + else { | ||
| + // Update the preview with the edited text. | ||
| + refreshSelectedTab( (FileEditorTab)newTab ); | ||
| + } | ||
| + } | ||
| + } | ||
| + ); | ||
| + } | ||
| + | ||
| + private void initTextChangeListener( final FileEditorTab tab ) { | ||
| + tab.addTextChangeListener( | ||
| + (ObservableValue<? extends String> editor, | ||
| + final String oldValue, final String newValue) -> { | ||
| + refreshSelectedTab( tab ); | ||
| + } | ||
| + ); | ||
| + } | ||
| + | ||
| + private void initCaretParagraphListener( final FileEditorTab tab ) { | ||
| + tab.addCaretParagraphListener( | ||
| + (ObservableValue<? extends Integer> editor, | ||
| + final Integer oldValue, final Integer newValue) -> { | ||
| + refreshSelectedTab( tab ); | ||
| + } | ||
| + ); | ||
| + } | ||
| + | ||
| + private void initVariableNameInjector( final FileEditorTab tab ) { | ||
| + VariableNameInjector.listen( tab, getDefinitionPane() ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Watch for changes to external files. In particular, this awaits | ||
| + * modifications to any XSL files associated with XML files being edited. When | ||
| + * an XSL file is modified (external to the application), the snitch's ears | ||
| + * perk up and the file is reloaded. This keeps the XSL transformation up to | ||
| + * date with what's on the file system. | ||
| + */ | ||
| + private void initSnitch() { | ||
| + getSnitch().addObserver( this ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Called whenever the preview pane becomes out of sync with the file editor | ||
| + * tab. This can be called when the text changes, the caret paragraph changes, | ||
| + * or the file tab changes. | ||
| + * | ||
| + * @param tab The file editor tab that has been changed in some fashion. | ||
| + */ | ||
| + private void refreshSelectedTab( final FileEditorTab tab ) { | ||
| + if( tab.isFileOpen() ) { | ||
| + getPreviewPane().setPath( tab.getPath() ); | ||
| + | ||
| + // TODO: https://github.com/DaveJarvis/scrivenvar/issues/29 | ||
| + final Position p = tab.getCaretOffset(); | ||
| + getLineNumberText().setText( | ||
| + get( STATUS_BAR_LINE, p.getMajor() + 1, p.getMinor() + 1 ) | ||
| + ); | ||
| + | ||
| + Processor<String> processor = getProcessors().get( tab ); | ||
| + | ||
| + if( processor == null ) { | ||
| + processor = createProcessor( tab ); | ||
| + getProcessors().put( tab, processor ); | ||
| + } | ||
| + | ||
| + try { | ||
| + processor.processChain( tab.getEditorText() ); | ||
| + getNotifier().clear(); | ||
| + } catch( final Exception ex ) { | ||
| + error( ex ); | ||
| + } | ||
| + } | ||
| + } | ||
| + | ||
| + /** | ||
| + * Returns the variable map of interpolated definitions. | ||
| + * | ||
| + * @return A map to help dereference variables. | ||
| + */ | ||
| + private Map<String, String> getResolvedMap() { | ||
| + return getDefinitionSource().getResolvedMap(); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Returns the root node for the hierarchical definition source. | ||
| + * | ||
| + * @return Data to display in the definition pane. | ||
| + */ | ||
| + private TreeView<String> getTreeView() { | ||
| + try { | ||
| + return getDefinitionSource().asTreeView(); | ||
| + } catch( Exception e ) { | ||
| + error( e ); | ||
| + } | ||
| + | ||
| + return new TreeView<>(); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Called when a definition source is opened. | ||
| + * | ||
| + * @param path Path to the definition source that was opened. | ||
| + */ | ||
| + private void openDefinition( final Path path ) { | ||
| + try { | ||
| + final DefinitionSource ds = createDefinitionSource( path.toString() ); | ||
| + setDefinitionSource( ds ); | ||
| + storeDefinitionSource(); | ||
| + updateDefinitionPane(); | ||
| + } catch( final Exception e ) { | ||
| + error( e ); | ||
| + } | ||
| + } | ||
| + | ||
| + private void updateDefinitionPane() { | ||
| + getDefinitionPane().setRoot( getDefinitionSource().asTreeView() ); | ||
| + } | ||
| + | ||
| + private void restoreDefinitionSource() { | ||
| + final Preferences preferences = getPreferences(); | ||
| + final String source = preferences.get( PREFS_DEFINITION_SOURCE, null ); | ||
| + | ||
| + // If there's no definition source set, don't try to load it. | ||
| + if( source != null ) { | ||
| + setDefinitionSource( createDefinitionSource( source ) ); | ||
| + } | ||
| + } | ||
| + | ||
| + private void storeDefinitionSource() { | ||
| + final Preferences preferences = getPreferences(); | ||
| + final DefinitionSource ds = getDefinitionSource(); | ||
| + | ||
| + preferences.put( PREFS_DEFINITION_SOURCE, ds.toString() ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Called when the last open tab is closed to clear the preview pane. | ||
| + */ | ||
| + private void closeRemainingTab() { | ||
| + getPreviewPane().clear(); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Called when an exception occurs that warrants the user's attention. | ||
| + * | ||
| + * @param e The exception with a message that the user should know about. | ||
| + */ | ||
| + private void error( final Exception e ) { | ||
| + getNotifier().notify( e ); | ||
| + } | ||
| + | ||
| + //---- File actions ------------------------------------------------------- | ||
| + /** | ||
| + * Called when an observable instance has changed. This includes the snitch | ||
| + * service and the notify service. | ||
| + * | ||
| + * @param observable The observed instance. | ||
| + * @param value The noteworthy item. | ||
| + */ | ||
| + @Override | ||
| + public void update( final Observable observable, final Object value ) { | ||
| + if( value != null ) { | ||
| + if( observable instanceof Snitch && value instanceof Path ) { | ||
| + update( (Path)value ); | ||
| + } | ||
| + else if( observable instanceof Notifier && value instanceof String ) { | ||
| + final String s = (String)value; | ||
| + final int index = s.indexOf( '\n' ); | ||
| + final String message = s.substring( 0, index > 0 ? index : s.length() ); | ||
| + | ||
| + getStatusBar().setText( message ); | ||
| + } | ||
| + } | ||
| + } | ||
| + | ||
| + /** | ||
| + * Called when a file has been modified. | ||
| + * | ||
| + * @param file Path to the modified file. | ||
| + */ | ||
| + private void update( final Path file ) { | ||
| + // Avoid throwing IllegalStateException by running from a non-JavaFX thread. | ||
| + Platform.runLater( | ||
| + () -> { | ||
| + // Brute-force XSLT file reload by re-instantiating all processors. | ||
| + resetProcessors(); | ||
| + refreshSelectedTab( getActiveFileEditor() ); | ||
| + } | ||
| + ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * After resetting the processors, they will refresh anew to be up-to-date | ||
| + * with the files (text and definition) currently loaded into the editor. | ||
| + */ | ||
| + private void resetProcessors() { | ||
| + getProcessors().clear(); | ||
| + } | ||
| + | ||
| + //---- File actions ------------------------------------------------------- | ||
| + private void fileNew() { | ||
| + getFileEditorPane().newEditor(); | ||
| + } | ||
| + | ||
| + private void fileOpen() { | ||
| + getFileEditorPane().openFileDialog(); | ||
| + } | ||
| + | ||
| + private void fileClose() { | ||
| + getFileEditorPane().closeEditor( getActiveFileEditor(), true ); | ||
| + } | ||
| + | ||
| + private void fileCloseAll() { | ||
| + getFileEditorPane().closeAllEditors(); | ||
| + } | ||
| + | ||
| + private void fileSave() { | ||
| + getFileEditorPane().saveEditor( getActiveFileEditor() ); | ||
| + } | ||
| + | ||
| + private void fileSaveAll() { | ||
| + getFileEditorPane().saveAllEditors(); | ||
| + } | ||
| + | ||
| + private void fileExit() { | ||
| + final Window window = getWindow(); | ||
| + fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) ); | ||
| + } | ||
| + | ||
| + //---- Help actions ------------------------------------------------------- | ||
| + private void helpAbout() { | ||
| + Alert alert = new Alert( AlertType.INFORMATION ); | ||
| + alert.setTitle( get( "Dialog.about.title" ) ); | ||
| + alert.setHeaderText( get( "Dialog.about.header" ) ); | ||
| + alert.setContentText( get( "Dialog.about.content" ) ); | ||
| + alert.setGraphic( new ImageView( new Image( FILE_LOGO_32 ) ) ); | ||
| + alert.initOwner( getWindow() ); | ||
| + | ||
| + alert.showAndWait(); | ||
| + } | ||
| + | ||
| + //---- Convenience accessors ---------------------------------------------- | ||
| + private float getFloat( final String key, final float defaultValue ) { | ||
| + return getPreferences().getFloat( key, defaultValue ); | ||
| + } | ||
| + | ||
| + private Preferences getPreferences() { | ||
| + return getOptions().getState(); | ||
| + } | ||
| + | ||
| + protected Scene getScene() { | ||
| + if( this.scene == null ) { | ||
| + this.scene = createScene(); | ||
| + } | ||
| + | ||
| + return this.scene; | ||
| + } | ||
| + | ||
| + public Window getWindow() { | ||
| + return getScene().getWindow(); | ||
| + } | ||
| + | ||
| + private MarkdownEditorPane getActiveEditor() { | ||
| + final EditorPane pane = getActiveFileEditor().getEditorPane(); | ||
| + | ||
| + return pane instanceof MarkdownEditorPane ? (MarkdownEditorPane)pane : null; | ||
| + } | ||
| + | ||
| + private FileEditorTab getActiveFileEditor() { | ||
| + return getFileEditorPane().getActiveFileEditor(); | ||
| + } | ||
| + | ||
| + //---- Member accessors --------------------------------------------------- | ||
| + private void setScene( Scene scene ) { | ||
| + this.scene = scene; | ||
| + } | ||
| + | ||
| + private void setProcessors( final Map<FileEditorTab, Processor<String>> map ) { | ||
| + this.processors = map; | ||
| + } | ||
| + | ||
| + private Map<FileEditorTab, Processor<String>> getProcessors() { | ||
| + if( this.processors == null ) { | ||
| + setProcessors( new HashMap<>() ); | ||
| + } | ||
| + | ||
| + return this.processors; | ||
| + } | ||
| + | ||
| + private FileEditorTabPane getFileEditorPane() { | ||
| + if( this.fileEditorPane == null ) { | ||
| + this.fileEditorPane = createFileEditorPane(); | ||
| + } | ||
| + | ||
| + return this.fileEditorPane; | ||
| + } | ||
| + | ||
| + private HTMLPreviewPane getPreviewPane() { | ||
| + if( this.previewPane == null ) { | ||
| + this.previewPane = createPreviewPane(); | ||
| + } | ||
| + | ||
| + return this.previewPane; | ||
| + } | ||
| + | ||
| + private void setDefinitionSource( final DefinitionSource definitionSource ) { | ||
| + this.definitionSource = definitionSource; | ||
| + } | ||
| + | ||
| + private DefinitionSource getDefinitionSource() { | ||
| + if( this.definitionSource == null ) { | ||
| + this.definitionSource = new EmptyDefinitionSource(); | ||
| + } | ||
| + | ||
| + return this.definitionSource; | ||
| + } | ||
| + | ||
| + private DefinitionPane getDefinitionPane() { | ||
| + if( this.definitionPane == null ) { | ||
| + this.definitionPane = createDefinitionPane(); | ||
| + } | ||
| + | ||
| + return this.definitionPane; | ||
| + } | ||
| + | ||
| + private Options getOptions() { | ||
| + return this.options; | ||
| + } | ||
| + | ||
| + private Snitch getSnitch() { | ||
| + return this.snitch; | ||
| + } | ||
| + | ||
| + private Notifier getNotifier() { | ||
| + return this.notifier; | ||
| + } | ||
| + | ||
| + public void setMenuBar( final MenuBar menuBar ) { | ||
| + this.menuBar = menuBar; | ||
| + } | ||
| + | ||
| + public MenuBar getMenuBar() { | ||
| + return this.menuBar; | ||
| + } | ||
| + | ||
| + private Text getLineNumberText() { | ||
| + if( this.lineNumberText == null ) { | ||
| + this.lineNumberText = createLineNumberText(); | ||
| + } | ||
| + | ||
| + return this.lineNumberText; | ||
| + } | ||
| + | ||
| + private synchronized StatusBar getStatusBar() { | ||
| + if( this.statusBar == null ) { | ||
| + this.statusBar = createStatusBar(); | ||
| + } | ||
| + | ||
| + return this.statusBar; | ||
| + } | ||
| + | ||
| + //---- Member creators ---------------------------------------------------- | ||
| + /** | ||
| + * Factory to create processors that are suited to different file types. | ||
| + * | ||
| + * @param tab The tab that is subjected to processing. | ||
| + * | ||
| + * @return A processor suited to the file type specified by the tab's path. | ||
| + */ | ||
| + private Processor<String> createProcessor( final FileEditorTab tab ) { | ||
| + return createProcessorFactory().createProcessor( tab ); | ||
| + } | ||
| + | ||
| + private ProcessorFactory createProcessorFactory() { | ||
| + return new ProcessorFactory( getPreviewPane(), getResolvedMap() ); | ||
| + } | ||
| + | ||
| + private DefinitionSource createDefinitionSource( final String path ) { | ||
| + return createDefinitionFactory().createDefinitionSource( path ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Create an editor pane to hold file editor tabs. | ||
| + * | ||
| + * @return A new instance, never null. | ||
| + */ | ||
| + private FileEditorTabPane createFileEditorPane() { | ||
| + return new FileEditorTabPane(); | ||
| + } | ||
| + | ||
| + private HTMLPreviewPane createPreviewPane() { | ||
| + return new HTMLPreviewPane(); | ||
| + } | ||
| + | ||
| + private DefinitionPane createDefinitionPane() { | ||
| + return new DefinitionPane( getTreeView() ); | ||
| + } | ||
| + | ||
| + private DefinitionFactory createDefinitionFactory() { | ||
| + return new DefinitionFactory(); | ||
| + } | ||
| + | ||
| + private StatusBar createStatusBar() { | ||
| + return new StatusBar(); | ||
| + } | ||
| + | ||
| + private Scene createScene() { | ||
| + final SplitPane splitPane = new SplitPane( | ||
| + getDefinitionPane().getNode(), | ||
| + getFileEditorPane().getNode(), | ||
| + getPreviewPane().getNode() ); | ||
| + | ||
| + splitPane.setDividerPositions( | ||
| + getFloat( K_PANE_SPLIT_DEFINITION, .10f ), | ||
| + getFloat( K_PANE_SPLIT_EDITOR, .45f ), | ||
| + getFloat( K_PANE_SPLIT_PREVIEW, .45f ) ); | ||
| + | ||
| + // See: http://broadlyapplicable.blogspot.ca/2015/03/javafx-capture-restorePreferences-splitpane.html | ||
| + final BorderPane borderPane = new BorderPane(); | ||
| + borderPane.setPrefSize( 1024, 800 ); | ||
| + borderPane.setTop( createMenuBar() ); | ||
| + borderPane.setBottom( getStatusBar() ); | ||
| + borderPane.setCenter( splitPane ); | ||
| + | ||
| + final VBox box = new VBox(); | ||
| + box.setAlignment( Pos.BASELINE_CENTER ); | ||
| + box.getChildren().add( getLineNumberText() ); | ||
| + getStatusBar().getRightItems().add( box ); | ||
| + | ||
| + return new Scene( borderPane ); | ||
| + } | ||
| + | ||
| + private Text createLineNumberText() { | ||
| + return new Text( get( STATUS_BAR_LINE, 1, 1 ) ); | ||
| } | ||