Package xal.app.scan1d

Class ScanDocument1D

java.lang.Object

xal.extension.application.XalDocument

xal.extension.application.smf.AcceleratorDocument

xal.app.scan1d.ScanDocument1D

All Implemented Interfaces:

Pageable

public class ScanDocument1D
extends xal.extension.application.smf.AcceleratorDocument

ScanDocument1D is a custom XalDocument for 1D scan application. The document manages the data that is displayed in the window.

Author:

shishlo

Field Summary

Fields

Modifier and Type	Field	Description
protected xal.tools.messaging.MessageCenter	messageCenter
static int	NO_OPTION
protected static String	SAVE_FAILED_TITLE
protected URL	source
static String	WILDCARD_FILE_EXTENSION
static int	YES_OPTION

Fields inherited from class xal.extension.application.smf.AcceleratorDocument

accelerator, acceleratorFilePath, selectedSequence, selectedSequenceList

Fields inherited from class xal.extension.application.XalDocument

mainWindow

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors

Constructor	Description
ScanDocument1D()	Create a new empty ScanDocument1D
ScanDocument1D(URL url)	Create a new document loaded from the URL file

Method Summary

Modifier and Type	Method	Description
void	acceleratorChanged()
void	customizeCommands(xal.extension.application.Commander commander)	Register actions for the menu items and toolbar.
int	displayConfirmDialog(String arg0, String arg1)
void	displayError(Exception arg0)
void	displayError(String arg0, String arg1)
void	displayError(String arg0, String arg1, Exception arg2)
void	displayWarning(Exception arg0)
void	displayWarning(String arg0, String arg1)
void	displayWarning(String arg0, String arg1, Exception arg2)
void	freeCustomResources()	Dispose of ScanDocument1D resources.
String	getCustomMenuDefinitionResource()
File	getDefaultFolder()
URL	getDefaultFolderURL()
String	getDisplayFilePath()
String	getEmptyDocumentPath()
String	getFileNameForSaving()
String	getNewDocumentName(String arg0)
String	getNewFileName()
int	getNumberOfPages()
PageFormat	getPageFormat(int arg0)
Printable	getPrintable(int arg0)
URL	getSource()
String	getTitle()
void	handleDataWrittenTo(xal.tools.data.DataListener arg0, URL arg1)
boolean	hasChanges()
void	hideDocument()
boolean	isEmpty()
void	makeMainWindow()	Make a main window by instantiating the ScanWindow1D window.
void	readScanDocument(URL url)	Reads the content of the document from the specified URL.
void	saveDocument()
void	saveDocumentAs(URL url)	Save the ScanDocument1D document to the specified URL.
void	setSource(URL arg0)
void	showDocument()
boolean	warnUserOfUnsavedChangesWhenClosing()
void	willClose()
void	windowOpened()
void	windowWillOpen()
String[]	writableDocumentTypes()
void	writeDataTo(xal.tools.data.DataListener arg0, URL arg1)

Methods inherited from class xal.extension.application.smf.AcceleratorDocument

acceleratorFilePathChanged, applySelectedAcceleratorWithDefaultPath, catchXmlDataAdaptorException, generateDocumentTitle, getAccelerator, getAcceleratorFilePath, getAcceleratorWindow, getNewFileNamePrefix, getSelectedSequence, getSelectedSequenceList, isSelectedSequenceRing, loadDefaultAccelerator, nextChannelFactory, selectedSequenceChanged, setAccelerator, setAcceleratorFilePath, setSelectedSequence, setSelectedSequenceList

Methods inherited from class xal.extension.application.XalDocument

addXalDocumentListener, closeDocument, freeResources, getDefaultWindowReference, getDocumentView, getMainWindow, registerEvents, removeXalDocumentListener, setHasChanges, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD_FILE_EXTENSION

public static final String WILDCARD_FILE_EXTENSION

See Also:

Constant Field Values

YES_OPTION

public static final int YES_OPTION

See Also:

Constant Field Values

NO_OPTION

public static final int NO_OPTION

See Also:

Constant Field Values

SAVE_FAILED_TITLE

protected static final String SAVE_FAILED_TITLE

See Also:

Constant Field Values

messageCenter

protected xal.tools.messaging.MessageCenter messageCenter

source

protected URL source

Constructor Detail

ScanDocument1D

public ScanDocument1D()

Create a new empty ScanDocument1D

ScanDocument1D

public ScanDocument1D(URL url)

Create a new document loaded from the URL file

Parameters:

url - The URL of the file to load into the new document.

Method Detail

readScanDocument

public void readScanDocument(URL url)

Reads the content of the document from the specified URL.

Parameters:

url - Description of the Parameter

makeMainWindow

public void makeMainWindow()

Make a main window by instantiating the ScanWindow1D window.

freeCustomResources

public void freeCustomResources()

Dispose of ScanDocument1D resources. This method overrides an empty superclass method.

saveDocumentAs

public void saveDocumentAs(URL url)

Save the ScanDocument1D document to the specified URL.

Parameters:

url - Description of the Parameter

customizeCommands

public void customizeCommands(xal.extension.application.Commander commander)

Register actions for the menu items and toolbar.

Parameters:

commander - Description of the Parameter

acceleratorChanged

public void acceleratorChanged()

Overrides:

acceleratorChanged in class xal.extension.application.smf.AcceleratorDocument

writableDocumentTypes

public String[] writableDocumentTypes()

getCustomMenuDefinitionResource

public String getCustomMenuDefinitionResource()

getTitle

public String getTitle()

getSource

public URL getSource()

getDefaultFolder

public File getDefaultFolder()

getDefaultFolderURL

public URL getDefaultFolderURL()

setSource

public void setSource(URL arg0)

isEmpty

public boolean isEmpty()

getDisplayFilePath

public String getDisplayFilePath()

getFileNameForSaving

public String getFileNameForSaving()

getNewFileName

public String getNewFileName()

getNewDocumentName

public String getNewDocumentName(String arg0)

getEmptyDocumentPath

public String getEmptyDocumentPath()

hasChanges

public boolean hasChanges()

saveDocument

public void saveDocument()

writeDataTo

public void writeDataTo(xal.tools.data.DataListener arg0,
                        URL arg1)

handleDataWrittenTo

public void handleDataWrittenTo(xal.tools.data.DataListener arg0,
                                URL arg1)

warnUserOfUnsavedChangesWhenClosing

public boolean warnUserOfUnsavedChangesWhenClosing()

willClose

public void willClose()

windowWillOpen

public void windowWillOpen()

windowOpened

public void windowOpened()

showDocument

public void showDocument()

hideDocument

public void hideDocument()

displayConfirmDialog

public int displayConfirmDialog(String arg0,
                                String arg1)

displayWarning

public void displayWarning(String arg0,
                           String arg1)

displayWarning

public void displayWarning(Exception arg0)

displayWarning

public void displayWarning(String arg0,
                           String arg1,
                           Exception arg2)

displayError

public void displayError(String arg0,
                         String arg1)

displayError

public void displayError(Exception arg0)

displayError

public void displayError(String arg0,
                         String arg1,
                         Exception arg2)

getNumberOfPages

public int getNumberOfPages()

Specified by:

getNumberOfPages in interface Pageable

getPageFormat

public PageFormat getPageFormat(int arg0)
                         throws IndexOutOfBoundsException

Specified by:

getPageFormat in interface Pageable

Throws:

IndexOutOfBoundsException

getPrintable

public Printable getPrintable(int arg0)
                       throws IndexOutOfBoundsException

Specified by:

getPrintable in interface Pageable

Throws:

IndexOutOfBoundsException