Package jmri.jmrit.logixng.actions
Class ActionFindTableRowOrColumn
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.jmrit.logixng.implementation.AbstractBase
-
- jmri.jmrit.logixng.actions.AbstractDigitalAction
-
- jmri.jmrit.logixng.actions.ActionFindTableRowOrColumn
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener,java.beans.VetoableChangeListener,java.lang.Comparable<NamedBean>,java.util.EventListener,PropertyChangeProvider,Base,DigitalAction,DigitalActionBean,NamedBean
public class ActionFindTableRowOrColumn extends AbstractDigitalAction implements java.beans.PropertyChangeListener, java.beans.VetoableChangeListener
This action finds a table row or column.
-
-
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_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description ActionFindTableRowOrColumn(java.lang.String sys, java.lang.String user)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddisposeMe()Dispose this class.voidexecute()Execute this DigitalActionBean.LogixNG_CategorygetCategory()Get the category.FemaleSocketgetChild(int index)Get a child of this itemintgetChildCount()Get the number of children.BasegetDeepCopy(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.booleangetIncludeCellsWithoutHeader()Set whenever to include cells that doesn't have a header.java.lang.StringgetLocalVariableNamedBean()java.lang.StringgetLocalVariableRow()java.lang.StringgetLongDescription(java.util.Locale locale)Get a long description of this item.java.lang.StringgetRowOrColumnName()Get name of row or columnLogixNG_SelectNamedBean<NamedTable>getSelectNamedBean()java.lang.StringgetShortDescription(java.util.Locale locale)Get a short description of this item.TableRowOrColumngetTableRowOrColumn()Get tableRowOrColumn.voidgetUsageDetail(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.voidpropertyChange(java.beans.PropertyChangeEvent evt)voidregisterListenersForThisClass()Register listeners if this object needs that.voidsetIncludeCellsWithoutHeader(boolean includeCellsWithoutHeader)Set whenever to include cells that doesn't have a header.voidsetLocalVariableNamedBean(java.lang.String localVariableNamedBean)voidsetLocalVariableRow(java.lang.String localVariableNewValue)voidsetRowOrColumnName(java.lang.String rowOrColumnName)Set name of row or columnvoidsetTableRowOrColumn(TableRowOrColumn tableRowOrColumn)Set tableRowOrColumn.voidsetup()Setup this object and its children.voidunregisterListenersForThisClass()Unregister listeners if this object needs that.-
Methods inherited from class jmri.jmrit.logixng.actions.AbstractDigitalAction
getBeanType, getNewSocketName, getNewSocketName, getParent, getPreferredSocketPrefix, getState, setParent, setState
-
Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase
assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, 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, deepCopyChildren, dispose, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
ActionFindTableRowOrColumn
public ActionFindTableRowOrColumn(java.lang.String sys, java.lang.String user) throws NamedBean.BadUserNameException, NamedBean.BadSystemNameException
-
-
Method Detail
-
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 ParserException
Description copied from interface:BaseCreate 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:
getDeepCopyin 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:
ParserException
-
getSelectNamedBean
public LogixNG_SelectNamedBean<NamedTable> getSelectNamedBean()
-
getTableRowOrColumn
public TableRowOrColumn getTableRowOrColumn()
Get tableRowOrColumn.- Returns:
- tableRowOrColumn
-
setTableRowOrColumn
public void setTableRowOrColumn(@Nonnull TableRowOrColumn tableRowOrColumn)
Set tableRowOrColumn.- Parameters:
tableRowOrColumn- tableRowOrColumn
-
getRowOrColumnName
public java.lang.String getRowOrColumnName()
Get name of row or column- Returns:
- name of row or column
-
setRowOrColumnName
public void setRowOrColumnName(@Nonnull java.lang.String rowOrColumnName)
Set name of row or column- Parameters:
rowOrColumnName- name of row or column
-
getIncludeCellsWithoutHeader
public boolean getIncludeCellsWithoutHeader()
Set whenever to include cells that doesn't have a header. Cells without headers can be used to use some cells in the table as comments.- Returns:
- true if include cells that doesn't have a header, false otherwise
-
setIncludeCellsWithoutHeader
public void setIncludeCellsWithoutHeader(boolean includeCellsWithoutHeader)
Set whenever to include cells that doesn't have a header. Cells without headers can be used to use some cells in the table as comments.- Parameters:
includeCellsWithoutHeader- true if include rows/columns that doesn't have a header, false otherwise
-
setLocalVariableNamedBean
public void setLocalVariableNamedBean(java.lang.String localVariableNamedBean)
-
getLocalVariableNamedBean
public java.lang.String getLocalVariableNamedBean()
-
setLocalVariableRow
public void setLocalVariableRow(java.lang.String localVariableNewValue)
-
getLocalVariableRow
public java.lang.String getLocalVariableRow()
-
getCategory
public LogixNG_Category getCategory()
Get the category.- Specified by:
getCategoryin interfaceBase- Overrides:
getCategoryin classAbstractBase- Returns:
- the category
-
execute
public void execute() throws JmriException
Execute this DigitalActionBean.- Specified by:
executein interfaceDigitalAction- Throws:
JmriException- when an exception occurs
-
getChild
public FemaleSocket getChild(int index) throws java.lang.IllegalArgumentException, java.lang.UnsupportedOperationException
Description copied from class:AbstractBaseGet a child of this item- Specified by:
getChildin interfaceBase- Overrides:
getChildin 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- when needed
-
getChildCount
public int getChildCount()
Description copied from class:AbstractBaseGet the number of children.- Specified by:
getChildCountin interfaceBase- Overrides:
getChildCountin classAbstractBase- Returns:
- the number of children
-
getShortDescription
public java.lang.String getShortDescription(java.util.Locale locale)
Description copied from interface:BaseGet a short description of this item.- Specified by:
getShortDescriptionin 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:BaseGet a long description of this item.- Specified by:
getLongDescriptionin interfaceBase- Parameters:
locale- The locale to be used- Returns:
- a long description
-
setup
public void setup()
Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.
-
registerListenersForThisClass
public void registerListenersForThisClass()
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:
registerListenersForThisClassin classAbstractBase
-
unregisterListenersForThisClass
public void unregisterListenersForThisClass()
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:
unregisterListenersForThisClassin classAbstractBase
-
propertyChange
public void propertyChange(java.beans.PropertyChangeEvent evt)
- Specified by:
propertyChangein interfacejava.beans.PropertyChangeListener
-
disposeMe
public void disposeMe()
Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().- Overrides:
disposeMein classAbstractBase
-
getUsageDetail
public void getUsageDetail(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)
Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.NamedBeanUsageReport Usage keys:
- LogixNGAction
- LogixNGExpression
- Specified by:
getUsageDetailin interfaceBase- Overrides:
getUsageDetailin classAbstractBase- Parameters:
level- The current recursion level for debugging.bean- The named bean that is the object of the search.report- A list of NamedBeanUsageReport usage reports.cdl- The current ConditionalNG bean. Null for Module searches since there is no conditional
-
-