xal.smf.data

Class OpticsSwitcher

java.lang.Object

xal.smf.data.OpticsSwitcher

public class OpticsSwitcher
extends java.lang.Object

OpticsSwitcher is a provides a view that allows the user to select an optics file as the default optics.

Since:

May 28, 2004

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpticsSwitcher() Constructor which defaults to showing dispose buttons
protected	OpticsSwitcher(boolean includeDisposeButtons) Constructor
protected	OpticsSwitcher(boolean includeDisposeButtons, java.lang.Runnable disposalHandler) Primary Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultOpticsPath() Get the path to the default optics file
static OpticsSwitcher	getInstance() Create an instance with an automatically configured hosting dialog
static OpticsSwitcher	getInstanceForHostedDialog(java.lang.Runnable disposalHandler) Create an instance appropriate for a hosted custom dialog
static OpticsSwitcher	getInstanceForHostedFrame() Create an instance appropriate for a hosted custom frame
java.awt.Component	getView() Get the view which may optionally be hosted in a custom window
boolean	isCanceled() determine whether the dialog was canceled
void	reset() reset editor to the default settings
void	setDisposalHandler(java.lang.Runnable handler) Set the callback to capture the user cancel and close events.
void	showDialogNearOwner(java.awt.Dialog owner) Show the dialog near the dialog's owner
void	showDialogNearOwner(java.awt.Frame owner) Show the dialog near the dialog's owner
void	showDialogWithOwnerNear(java.awt.Dialog owner, java.awt.Component view) Show the dialog near the specified view
void	showDialogWithOwnerNear(java.awt.Frame owner, java.awt.Component view) Show the dialog near the specified view

Methods inherited from class java.lang.Object

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

Constructor Detail

OpticsSwitcher

protected OpticsSwitcher(boolean includeDisposeButtons,
                         java.lang.Runnable disposalHandler)

Primary Constructor

Parameters:

includeDisposeButtons - indicates whether to show cancel and close buttons which are appropriate for a hosting dialog

disposalHandler - callback for cancel and close events

OpticsSwitcher

protected OpticsSwitcher(boolean includeDisposeButtons)

Constructor

Parameters:

includeDisposeButtons - indicates whether to show cancel and close buttons which are appropriate for a hosting dialog

OpticsSwitcher

protected OpticsSwitcher()

Constructor which defaults to showing dispose buttons

Method Detail

getInstance

public static OpticsSwitcher getInstance()

Create an instance with an automatically configured hosting dialog

getInstanceForHostedFrame

public static OpticsSwitcher getInstanceForHostedFrame()

Create an instance appropriate for a hosted custom frame

getInstanceForHostedDialog

public static OpticsSwitcher getInstanceForHostedDialog(java.lang.Runnable disposalHandler)

Create an instance appropriate for a hosted custom dialog

getView

public java.awt.Component getView()

Get the view which may optionally be hosted in a custom window

setDisposalHandler

public void setDisposalHandler(java.lang.Runnable handler)

Set the callback to capture the user cancel and close events. Call this method if the view will be hosted in a custom dialog

reset

public void reset()

reset editor to the default settings

showDialogNearOwner

public void showDialogNearOwner(java.awt.Frame owner)

Show the dialog near the dialog's owner

Parameters:

owner - window which owns the dialog

showDialogWithOwnerNear

public void showDialogWithOwnerNear(java.awt.Frame owner,
                                    java.awt.Component view)

Show the dialog near the specified view

Parameters:

owner - window which owns the dialog

view - the view near which to show this dialog

showDialogNearOwner

public void showDialogNearOwner(java.awt.Dialog owner)

Show the dialog near the dialog's owner

Parameters:

owner - window which owns the dialog

showDialogWithOwnerNear

public void showDialogWithOwnerNear(java.awt.Dialog owner,
                                    java.awt.Component view)

Show the dialog near the specified view

Parameters:

owner - window which owns the dialog

view - the view near which to show this dialog

getDefaultOpticsPath

public java.lang.String getDefaultOpticsPath()

Get the path to the default optics file

Returns:

the path to the default optics file

isCanceled

public boolean isCanceled()

determine whether the dialog was canceled