Package xal.extension.fxapplication

Class XalFxDocument

java.lang.Object
xal.extension.fxapplication.XalFxDocument
public abstract class XalFxDocument extends Object
The base class for custom documents for JavaFX applications.
Author:
Yngve Levinsen <yngve.levinsen@ess.eu>

  • Field Details

    • FILETYPE_DESCRIPTION

      protected String FILETYPE_DESCRIPTION
      wildcard file extension

    • WILDCARD_FILE_EXTENSION

      protected String WILDCARD_FILE_EXTENSION

    • DEFAULT_FILENAME

      protected String DEFAULT_FILENAME

    • sourceString

      protected javafx.beans.property.SimpleStringProperty sourceString

    • source

      protected URL source
      The persistent storage URL for the document

    • hasChanges

      protected boolean hasChanges

    • acceleratorXMLManager

      protected XMLDataManager acceleratorXMLManager
      The accelerator XML manager object

    • accelerator

      protected AcceleratorProperty accelerator
      The accelerator file in use

    • sequence

      protected javafx.beans.property.SimpleStringProperty sequence
      The selected Sequence/ComboSequence

    • mainStage

      protected javafx.stage.Stage mainStage
      The selected Stage for eLog Posts

    • HELP_PAGEID

      protected String HELP_PAGEID
      PageID of the Confluence page or web page with the help about the application

    • testMode

      protected boolean testMode
      Test mode flag, disabled by default

  • Constructor Details

    • XalFxDocument

      protected XalFxDocument()

    • XalFxDocument

      protected XalFxDocument(javafx.stage.Stage stage)

  • Method Details

    • setHasChanges

      public void setHasChanges(boolean changeStatus)
      Set the whether this document has changes.
      Parameters:
      changeStatus - Status to set whether this document has changes that need saving.

    • hasChanges

      public boolean hasChanges()
      Indicates if there are changes that need saving.
      Returns:
      Status of whether this document has changes that need saving.

    • sourceSetAndValid

      public boolean sourceSetAndValid()

    • setSource

      public void setSource(File newSource)

    • saveDocumentAs

      public abstract void saveDocumentAs(URL url)
      Subclasses need to implement this method for saving the document to a URL.
      Parameters:
      url - The File to which this document should be saved.

    • loadDocument

      public abstract void loadDocument(URL url)
      Subclasses need to implement this method for saving the document to a URL.
      Parameters:
      url - The URL to which this document should be saved.

    • newDocument

      public abstract void newDocument()
      Subclasses need to implement this method for creating a new document.

    • saveDocument

      public void saveDocument()
      Save this document to its persistent storage source.

    • eLogPost

      public void eLogPost(String docType)
      Method for creating a Logbook Post.

    • help

      public void help()
      Method for redirecting to the applications web page/internal page.

    • openUrl

      public void openUrl(String url)

    • getSequence

      public String getSequence()

    • getSequenceProperty

      public javafx.beans.property.SimpleStringProperty getSequenceProperty()

    • setSequence

      public void setSequence(String sequence)

    • getStage

      public javafx.stage.Stage getStage()

    • setStage

      public void setStage(javafx.stage.Stage mainStage)

    • getAccelerator

      public Accelerator getAccelerator()

    • setAccelerator

      public void setAccelerator(Accelerator accelerator)

    • getAcceleratorProperty

      public AcceleratorProperty getAcceleratorProperty()

    • getAcceleratorXMLManager

      public XMLDataManager getAcceleratorXMLManager()

    • setAcceleratorXMLManager

      public void setAcceleratorXMLManager(XMLDataManager xmlDataManager)

    • getFiletypeDescription

      public String getFiletypeDescription()

    • getWildcardFileExtension

      public String getWildcardFileExtension()

    • getDefaultFilename

      public String getDefaultFilename()

    • logbookProviderDialog

      protected static LogbookProvider logbookProviderDialog() throws LogbookException
      Throws:
      LogbookException