Package jmri.jmrix.dccpp.swing.messages

Class MessagesPositionableFactory

java.lang.Object

jmri.jmrix.dccpp.swing.messages.MessagesPositionableFactory

All Implemented Interfaces:

PositionableFactory

public class MessagesPositionableFactory
extends Object
implements PositionableFactory

A factory for a DCC-EX Messages display that can be put on a panel.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.jmrit.display.PositionableFactory

PositionableFactory.DoAfter

Constructor Summary

Constructors

Constructor	Description
MessagesPositionableFactory()

Method Summary

Modifier and Type	Method	Description
void	addPositionable(Editor editor, PositionableFactory.DoAfter doAfter)	Add a positionable to the panel.
String	getDescription()	Get the description for this factory.
String	getIdentifier()	Get an unique identifier for this factory.
boolean	isEnabled()	Only offered when there's at least one DCC-EX connection.

Methods inherited from class java.lang.Object

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

Constructor Details

MessagesPositionableFactory

public MessagesPositionableFactory()

Method Details

getIdentifier

@Nonnull
public String getIdentifier()

Description copied from interface: PositionableFactory

Get an unique identifier for this factory. It's recommended that identifiers for connection specific factories begins with the connection type. Example: DCC-EX-VirtualDisplay.

Specified by:

getIdentifier in interface PositionableFactory

Returns:

an unique identifier for this factory

getDescription

@Nonnull
public String getDescription()

Description copied from interface: PositionableFactory

Get the description for this factory.

Specified by:

getDescription in interface PositionableFactory

Returns:

the description

isEnabled

public boolean isEnabled()

Only offered when there's at least one DCC-EX connection.

Specified by:

isEnabled in interface PositionableFactory

Returns:

true if enabled, false otherwise

addPositionable

public void addPositionable(@Nonnull
 Editor editor,
 PositionableFactory.DoAfter doAfter)

Description copied from interface: PositionableFactory

Add a positionable to the panel. The method might show a dialog to let the user configure the positionable.

Specified by:

addPositionable in interface PositionableFactory

Parameters:

editor - the editor to which the new positionable should be added

doAfter - an optional task to run after the positionable is added to the editor, or null if no task is needed