Package com.reportmill.editor

Class RMEditorUI

  • Direct Known Subclasses:
    OWEditorUI, OWEditorUI, RBEditorUI
    public class RMEditorUI
extends java.lang.Object
    This class contains all of the methods to display and handle RMEditor UI methods.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RMEditorUI.EditorViewport
      A Viewport for painting foreground.

    • Constructor Summary

      Constructors 
      Constructor Description
      RMEditorUI()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean close()
      Closes this editor ui
      void exportFlash​(java.lang.String aPath)
      Export as Flash to given path.
      void exportFlashHTML​(java.lang.String aPath)
      Export as Flash inside HTML wrapper to given path.
      void exportPDF​(java.lang.String aPath)
      Export as PDF to given path.
      RMEditor getEditor()
      Returns the editor UI's editor.
      static RMEditorUI getEditor​(int anIndex)
      Returns the specific editor at the given index from the list of all editors currently in the application.
      static int getEditorCount()
      Returns the number of active/visible editors.
      static RMEditorUI getEditorUI​(RMEditor anEditor)
      Returns the editor ui for the given editor.
      static RMEditor getMainEditor()
      Returns the editor in the editor ui window that was most recently activated.
      static RMEditorUI getMainEditorUI()
      Returns the editor ui that is the most recently activated.
      RJPanel getUI()
      Returns the Swing UI panel for the editor window.
      javax.swing.JFrame getWindow()
      Returns the editor window.
      RMEditorUI newDocument()
      Creates a new default editorUI.
      RMEditorUI open()
      Creates a new editor window from an open panel.
      RMEditorUI open​(java.lang.Object aSource)
      Creates a new editor window by opening the document from the given source.
      RMEditorUI openSample​(java.lang.String aTitle)
      Opens the named sample file from the examples package.
      void previewApplet()
      Preview Applet.
      void previewCSV()
      Preview CSV.
      void previewFlash()
      Preview flash.
      void previewHTML()
      Preview HTML.
      void previewJPG()
      Preview JPG.
      void previewPDF()
      Preview PDF.
      void previewPNG()
      Preview PNG.
      void previewXML()
      Preview XML.
      void quit()
      Callled when the app is about to exit to gracefully handle any open documents.
      static void removeEditor​(RMEditorUI anEditorUI)
      Remove given editor from editors list.
      void reset()
      Registers for Ribs reset.
      void resetUI()
      Updates the editor's UI.
      void respondUI​(java.lang.Object anObj)
      Handles changes to the editor's UI controls.
      void revert()
      Reloads the current editor document from the last saved version.
      void runWelcome()
      Runs the welcome panel.
      void save()
      Saves the current editor document, running the save panel if needed.
      void saveAs()
      Saves the current editor document, running the save panel.
      void saveAs​(java.lang.String aPath)
      Saves the current editor document to the given path.
      void setEditor​(RMEditor anEditor)
      Sets the editor ui's editor.
      static void setMainEditorUI​(RMEditorUI anEditorUI)
      Sets the editor that is most recently used.
      void setUI​(RJPanel aPanel)
      Sets the Swing UI panel.
      void showPopupMenu​(int x, int y)
      Runs a popup menu for the given editor at the given location.
      void toggleRulers()
      Toggles the rulers for this UI.
      void windowDidResize()
      Called when window resizes.
      boolean windowShouldClose​(boolean doClose)
      Returns whether this editor's window should close (can return no if doc has unsaved changes).

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RMEditorUI

        public RMEditorUI()

    • Method Detail

      • getUI

        public RJPanel getUI()
        Returns the Swing UI panel for the editor window.

      • setUI

        public void setUI​(RJPanel aPanel)
        Sets the Swing UI panel.

      • resetUI

        public void resetUI()
        Updates the editor's UI.

      • respondUI

        public void respondUI​(java.lang.Object anObj)
        Handles changes to the editor's UI controls.

      • reset

        public void reset()
        Registers for Ribs reset.

      • getMainEditorUI

        public static RMEditorUI getMainEditorUI()
        Returns the editor ui that is the most recently activated.

      • getMainEditor

        public static RMEditor getMainEditor()
        Returns the editor in the editor ui window that was most recently activated.

      • setMainEditorUI

        public static void setMainEditorUI​(RMEditorUI anEditorUI)
        Sets the editor that is most recently used.

      • getEditorUI

        public static RMEditorUI getEditorUI​(RMEditor anEditor)
        Returns the editor ui for the given editor.

      • getEditorCount

        public static int getEditorCount()
        Returns the number of active/visible editors.

      • getEditor

        public static RMEditorUI getEditor​(int anIndex)
        Returns the specific editor at the given index from the list of all editors currently in the application.

      • removeEditor

        public static void removeEditor​(RMEditorUI anEditorUI)
        Remove given editor from editors list.

      • getEditor

        public RMEditor getEditor()
        Returns the editor UI's editor.

      • setEditor

        public void setEditor​(RMEditor anEditor)
        Sets the editor ui's editor.

      • getWindow

        public javax.swing.JFrame getWindow()
        Returns the editor window.

      • newDocument

        public RMEditorUI newDocument()
        Creates a new default editorUI.

      • open

        public RMEditorUI open()
        Creates a new editor window from an open panel.

      • open

        public RMEditorUI open​(java.lang.Object aSource)
        Creates a new editor window by opening the document from the given source.

      • openSample

        public RMEditorUI openSample​(java.lang.String aTitle)
        Opens the named sample file from the examples package.

      • save

        public void save()
        Saves the current editor document, running the save panel if needed.

      • saveAs

        public void saveAs()
        Saves the current editor document, running the save panel.

      • saveAs

        public void saveAs​(java.lang.String aPath)
        Saves the current editor document to the given path.

      • revert

        public void revert()
        Reloads the current editor document from the last saved version.

      • close

        public boolean close()
        Closes this editor ui

      • quit

        public void quit()
        Callled when the app is about to exit to gracefully handle any open documents.

      • windowShouldClose

        public boolean windowShouldClose​(boolean doClose)
        Returns whether this editor's window should close (can return no if doc has unsaved changes).

      • runWelcome

        public void runWelcome()
        Runs the welcome panel.

      • windowDidResize

        public void windowDidResize()
        Called when window resizes.

      • showPopupMenu

        public void showPopupMenu​(int x,
                          int y)
        Runs a popup menu for the given editor at the given location.

      • toggleRulers

        public void toggleRulers()
        Toggles the rulers for this UI.

      • exportPDF

        public void exportPDF​(java.lang.String aPath)
        Export as PDF to given path.

      • exportFlash

        public void exportFlash​(java.lang.String aPath)
        Export as Flash to given path.

      • exportFlashHTML

        public void exportFlashHTML​(java.lang.String aPath)
        Export as Flash inside HTML wrapper to given path.

      • previewPDF

        public void previewPDF()
        Preview PDF.

      • previewFlash

        public void previewFlash()
        Preview flash.

      • previewHTML

        public void previewHTML()
        Preview HTML.

      • previewCSV

        public void previewCSV()
        Preview CSV.

      • previewJPG

        public void previewJPG()
        Preview JPG.

      • previewPNG

        public void previewPNG()
        Preview PNG.

      • previewXML

        public void previewXML()
        Preview XML.

      • previewApplet

        public void previewApplet()
        Preview Applet.