Class DefaultClipboard
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.implementation.DefaultClipboard
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,Base
,Clipboard
,NamedBean
public class DefaultClipboard extends AbstractBase implements Clipboard
Default implementation of the clipboard
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base
Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException
-
Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
-
Field Summary
-
Fields inherited from class jmri.jmrit.logixng.implementation.AbstractBase
_listenersAreRegistered
-
Fields inherited from class jmri.implementation.AbstractNamedBean
listenerRefs, mSystemName, register
-
Fields inherited from interface jmri.jmrit.logixng.Base
PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description DefaultClipboard()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(MaleSocket maleSocket, java.util.List<java.lang.String> errors)
Add an item to the clipboard.protected void
disposeMe()
Dispose this class.MaleSocket
fetchTopItem()
Get the top item on the clipboard and remove it from the clipboard.java.lang.String
getBeanType()
For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.Category
getCategory()
Get the category.FemaleSocket
getChild(int index)
Get a child of this itemint
getChildCount()
Get the number of children.Base
getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used.FemaleSocket
getFemaleSocket()
Get the female socket root of the clipboard tree.java.lang.String
getLongDescription(java.util.Locale locale)
Get a long description of this item.Base
getParent()
Get the parent.java.lang.String
getShortDescription(java.util.Locale locale)
Get a short description of this item.int
getState()
Provide generic access to internal state.MaleSocket
getTopItem()
Get the top item on the clipboard without removing it from the clipboard.boolean
isEmpty()
Is the clipboard empty?void
moveItemToTop(MaleSocket maleSocket)
Moves an item on the clipboard to the top of the clipboard.protected void
registerListenersForThisClass()
Register listeners if this object needs that.boolean
replaceClipboardItems(ClipboardMany clipboardItems, java.util.List<java.lang.String> errors)
void
setParent(Base parent)
Set the parent.void
setState(int s)
Provide generic access to internal state.void
setup()
Setup this object and its children.protected void
unregisterListenersForThisClass()
Unregister listeners if this object needs that.-
Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase
assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageDetail, getUsageTree, isActive, printTree, printTree, printTree, printTreeRow, registerListeners, setParentForAllChildren, unregisterListeners
-
Methods inherited from class jmri.implementation.AbstractNamedBean
addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, describeState, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface jmri.jmrit.logixng.Base
addPropertyChangeListener, addPropertyChangeListener, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getListenerRef, getListenerRefs, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getShortDescription, getSystemName, getUserName, hasChild, isEnabled, isSocketOperationAllowed, printTree, printTree, setComment, setUserName, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.NamedBean
compareTo, getUsageReport
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
DefaultClipboard
public DefaultClipboard()
-
-
Method Detail
-
isEmpty
public boolean isEmpty()
Description copied from interface:Clipboard
Is the clipboard empty?
-
add
public boolean add(MaleSocket maleSocket, java.util.List<java.lang.String> errors)
Description copied from interface:Clipboard
Add an item to the clipboard.The last added item is on the top of the clipboard.
-
fetchTopItem
public MaleSocket fetchTopItem()
Description copied from interface:Clipboard
Get the top item on the clipboard and remove it from the clipboard.The top item is the last item put on the clipboard
- Specified by:
fetchTopItem
in interfaceClipboard
- Returns:
- the top item
-
getTopItem
public MaleSocket getTopItem()
Description copied from interface:Clipboard
Get the top item on the clipboard without removing it from the clipboard.The top item is the last item put on the clipboard
- Specified by:
getTopItem
in interfaceClipboard
- Returns:
- the top item
-
getFemaleSocket
public FemaleSocket getFemaleSocket()
Description copied from interface:Clipboard
Get the female socket root of the clipboard tree.- Specified by:
getFemaleSocket
in interfaceClipboard
- Returns:
- the root female socket
-
moveItemToTop
public void moveItemToTop(MaleSocket maleSocket)
Description copied from interface:Clipboard
Moves an item on the clipboard to the top of the clipboard.If an item on the clipboard that is not the top item is cut, it's placed as the top item on the clipboard until it's pasted elsewhere.
- Specified by:
moveItemToTop
in interfaceClipboard
- Parameters:
maleSocket
- the male socket to put on the top
-
setup
public void setup()
Description copied from interface:Clipboard
Setup this object and its children. This method is used to lookup system names for child sockets.
-
replaceClipboardItems
public boolean replaceClipboardItems(ClipboardMany clipboardItems, java.util.List<java.lang.String> errors)
-
registerListenersForThisClass
protected void registerListenersForThisClass()
Description copied from class:AbstractBase
Register listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not registered more than once.
- Overrides:
registerListenersForThisClass
in classAbstractBase
-
unregisterListenersForThisClass
protected void unregisterListenersForThisClass()
Description copied from class:AbstractBase
Unregister listeners if this object needs that.Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not unregistered more than once.
- Overrides:
unregisterListenersForThisClass
in classAbstractBase
-
disposeMe
protected void disposeMe()
Description copied from class:AbstractBase
Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().- Overrides:
disposeMe
in classAbstractBase
-
setState
public void setState(int s) throws JmriException
Description copied from interface:NamedBean
Provide generic access to internal state.This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.
- Specified by:
setState
in interfaceNamedBean
- Parameters:
s
- the state- Throws:
JmriException
- general error when setting the state fails
-
getState
public int getState()
Description copied from interface:NamedBean
Provide generic access to internal state.This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.
-
getBeanType
public java.lang.String getBeanType()
Description copied from interface:NamedBean
For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.- Specified by:
getBeanType
in interfaceNamedBean
- Returns:
- a string of the bean type, eg Turnout, Sensor etc
-
getDeepCopy
public Base getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames) throws JmriException
Description copied from interface:Base
Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used. If no user name is given, a null user name is used.- Specified by:
getDeepCopy
in interfaceBase
- Parameters:
systemNames
- a map of old and new system nameuserNames
- a map of old system name and new user name- Returns:
- a deep copy
- Throws:
JmriException
- in case of an error
-
getShortDescription
public java.lang.String getShortDescription(java.util.Locale locale)
Description copied from interface:Base
Get a short description of this item.- Specified by:
getShortDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a short description
-
getLongDescription
public java.lang.String getLongDescription(java.util.Locale locale)
Description copied from interface:Base
Get a long description of this item.- Specified by:
getLongDescription
in interfaceBase
- Parameters:
locale
- The locale to be used- Returns:
- a long description
-
getParent
public Base getParent()
Description copied from interface:Base
Get the parent.The following rules apply
- LogixNGs has no parent. The method throws an UnsupportedOperationException if called.
- Expressions and actions has the male socket that they are connected to as their parent.
- Male sockets has the female socket that they are connected to as their parent.
- The parent of a female sockets is the LogixNG, expression or action that has this female socket.
- The parent of a male sockets is the same parent as the expression or action that it contains.
-
setParent
public void setParent(Base parent)
Description copied from interface:Base
Set the parent.The following rules apply
- ExecutionGroups has no parent. The method throws an UnsupportedOperationException if called.
- LogixNGs has the execution group as its parent.
- Expressions and actions has the male socket that they are connected to as their parent.
- Male sockets has the female socket that they are connected to as their parent.
- The parent of a female sockets is the LogixNG, expression or action that has this female socket.
- The parent of a male sockets is the same parent as the expression or action that it contains.
-
getChild
public FemaleSocket getChild(int index) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
Description copied from class:AbstractBase
Get a child of this item- Specified by:
getChild
in interfaceBase
- Overrides:
getChild
in classAbstractBase
- Parameters:
index
- the index of the child to get- Returns:
- the child
- Throws:
java.lang.IllegalArgumentException
- if the index is less than 0 or greater or equal with the value returned by getChildCount()java.lang.UnsupportedOperationException
-
getChildCount
public int getChildCount()
Description copied from class:AbstractBase
Get the number of children.- Specified by:
getChildCount
in interfaceBase
- Overrides:
getChildCount
in classAbstractBase
- Returns:
- the number of children
-
getCategory
public Category getCategory()
Description copied from class:AbstractBase
Get the category.- Specified by:
getCategory
in interfaceBase
- Overrides:
getCategory
in classAbstractBase
- Returns:
- the category
-
-