jmri.util.swing
Interface WindowInterface

Show UML class diagram

All Known Implementing Classes:

AbstractAudioFrame, AbstractMonFrame, AbstractPacketGenFrame, AcelaMonFrame, AcelaPacketGenFrame, AddEntryExitPairFrame, AddSensorJFrame, AddSignalMastJFrame, AlignTableFrame, AlmBrowserFrame, AlternateTrackFrame, AnalogClockFrame, AudioBufferFrame, AudioListenerFrame, AudioSourceFrame, AudioTableFrame, AutomatTableFrame, AutoTrainsFrame, BeanTableFrame, BlockBossFrame, BuildReportOptionFrame, CarAttributeEditFrame, CarEditFrame, CarLoadEditFrame, CarSetFrame, CarsSetFrame, CarsTableFrame, CbusEventFilterFrame, ChangeTrackFrame, ChangeTracksFrame, CircuitBuilder.convertFrame, CommonConductorYardmasterFrame, ConsistToolFrame, ControllerFilterFrame, ControlPanelEditor, CoordinateEdit, DataSource, DebuggerFrame, DecoderPro3Window, DiagnosticFrame, DispatcherFrame, DrawCircle, DrawEllipse, DrawFrame, DrawPolygon, DrawRectangle, DrawRoundRect, DualDecoderSelectFrame, EasyDccMonFrame, EasyDccPacketGenFrame, EditCircuitFrame, EditCircuitPaths, Editor, Editor.JFrameItem, EditorFrame, EditPortalFrame, EngineAttributeEditFrame, EngineEditFrame, EngineSetFrame, EnginesTableFrame, FollowerFrame, HexFileFrame, IconDialog, IgnoreUsedTrackFrame, ImageIndexEditor, IndicatorTOIconDialog, InterchangeEditFrame, ItemDialog, ItemPalette, JFrameInterface, JMRIClientMonFrame, JmriJFrame, JmriJFrameInterface, JmriJInternalFrameInterface, JmriServerFrame, JmriSRCPServerFrame, LayoutEditor, LcdClockFrame, LearnThrottleFrame, LI101Frame, ListedTableFrame, ListFrame, ListFrame, LIUSBConfigFrame, LoaderFrame, LocationEditFrame, LocationsByCarTypeFrame, LocationsTableFrame, LocoMonFrame, LogFrame, LV102Frame, LZ100Frame, LZV100Frame, ManageLocationsFrame, MdiMainFrame, MemoryIconCoordinateEdit, MonitorFrame, MrcMonFrame, MultiPaneWindow, MultiSensorIconDialog, MultiSensorIconFrame, Mx1MonFrame, NixieClockFrame, NodeConfigFrame, NodeConfigFrame, NodeConfigFrame, NodeConfigFrame, NodeConfigFrame, NodeConfigFrame, NodeTableFrame, OperationsFrame, OperationsSetupFrame, OptionFrame, OsIndicatorFrame, PacketGenFrame, PacketGenFrame, PacketGenFrame, PacketGenFrame, PacketGenFrame, PacketTableFrame, PanedInterface, PanelEditor, PanelProFrame, PaneOpsProgFrame, PaneProgFrame, PaneServiceProgFrame, PickFrame, PollTableFrame, PoolTrackFrame, PowerPanelFrame, PowerPanelFrame, PreferencesFrame, PrintCarRosterAction.CarPrintOptionFrame, PrintLocationsAction.LocationPrintOptionFrame, PrintMoreOptionFrame, PrintOptionFrame, QsiMonFrame, RenumberFrame, ReportFrame, RollingStockSetFrame, RosterFrame, RosterGroupTableFrame, RouteCopyFrame, RouteEditFrame, RoutesTableFrame, RpsMonFrame, RpsTrackingFrame, ScheduleEditFrame, ScheduleOptionsFrame, SchedulesByLoadFrame, SchedulesTableFrame, SendPacketFrame, SensorGroupFrame, SensorTextEdit, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialMonFrame, SerialPacketGenFrame, SerialPacketGenFrame, SerialPacketGenFrame, SerialPacketGenFrame, SerialPacketGenFrame, SerialPacketGenFrame, SerialPacketGenFrame, ServerFrame, SetPhysicalLocationAction.SetPhysicalLocationFrame, SetPhysicalLocationAction.SetPhysicalLocationFrame, SetPhysicalLocationFrame, SetTrainIconPositionFrame, SetTrainIconRouteFrame, SetupExcelProgramFrame, ShowCarsInTrainFrame, SignallingFrame, SignallingSourceFrame, SignalMastRepeaterJFrame, SimpleClockFrame, SimpleLightCtrlFrame, SimpleProgFrame, SimpleServerFrame, SimpleTurnoutCtrlFrame, SlipTurnoutTextEdit, SoundSetFrame, SpeedoConsoleFrame, SpeedometerFrame, SpeedProfileFrame, SprogConsoleFrame, SprogHexFile, SprogIIUpdateFrame, SprogMonFrame, SprogPacketGenFrame, SprogSlotMonFrame, SprogUpdateFrame, Sprogv4UpdateFrame, SprogVersionFrame, SpurEditFrame, SRCPMonFrame, StackMonFrame, StackNXWindow, StagingEditFrame, StatusFrame, SymbolicProgFrame, SystemInfoFrame, TabbedPreferencesFrame, TableFrames, ThreePaneTLRWindow, ThrottleWindow, TieToolFrame, TrackDestinationEditFrame, TrackEditCommentsFrame, TrackEditFrame, TrackerTableAction.TableFrame, TrackLoadEditFrame, TrackRoadEditFrame, TrainByCarTypeFrame, TrainConductorFrame, TrainCopyFrame, TrainEditBuildOptionsFrame, TrainEditFrame, TrainManifestOptionFrame, TrainsByCarTypeFrame, TrainScriptFrame, TrainsScheduleEditFrame, TrainsScheduleTableFrame, TrainsScriptFrame, TrainsTableFrame, TrainSwitchListEditFrame, TreeFrame, TwoPaneTBWindow, UserInterface, VSDecoderFrame, VSDManagerFrame, WarrantFrame, WarrantRoute, WarrantTableAction.NXFrame, WarrantTableAction.TableFrame, WiThrottlePrefsFrame, XNetMonFrame, XpaConfigureFrame, XpaMonFrame, XpaPacketGenFrame, YardEditFrame, YardmasterFrame, ZimoPacketGenFrame

public interface WindowInterface

Interface for an object that can arrange for a JmriPanel to be displayed.

Typically used by some component that wants to display a pane (e.g. in an independent JmriJFrame or as part of a paned interface) to do some more stuff. Rather than have the component build it's own window, etc it invokes one of these, so that the position and display of that component can controlled.

Any JmriAbstractAction that uses the show() method will have its dispose() invoked when the associated frame goes away. It should dispose() any cached panes at that time.

Since:

2.9.4

Nested Class Summary

static class

WindowInterface.Hint Suggested location for subsequent panels

Method Summary

void	dispose()
Frame	getFrame() Returns the WindowInterface as a Frame or null.
boolean	multipleInstances() Should 2nd and subsequent requests for a panel (e.g. in an Action) create a new instance, or provide the 1st one for reuse?
void	show(JmriPanel child, JmriAbstractAction action) Show, in whatever way is appropriate, a specific JmriPanel
void	show(JmriPanel child, JmriAbstractAction action, WindowInterface.Hint hint) Show, in whatever way is appropriate, a specific JmriPanel

Method Detail

show

void show(JmriPanel child,
          JmriAbstractAction action)

Show, in whatever way is appropriate, a specific JmriPanel

Parameters:

child - new JmriPanel to show

action - JmriAbstractAction making the request

show

void show(JmriPanel child,
          JmriAbstractAction action,
          WindowInterface.Hint hint)

Show, in whatever way is appropriate, a specific JmriPanel

Parameters:

child - new JmriPanel to show

action - JmriAbstractAction making the request

hint - suggestion on where to put the content

multipleInstances

boolean multipleInstances()

Should 2nd and subsequent requests for a panel (e.g. in an Action) create a new instance, or provide the 1st one for reuse? This would be true e.g. if separate windows were being provided, or false if there was only one window which is being populated with one pane after another.

Returns:

true if multiple instances should be provided, false if only one should be provided.

dispose

void dispose()

getFrame

Frame getFrame()

Returns the WindowInterface as a Frame or null.

Returns:

a Frame or null