Package jmri.jmrit.ctc.editor.code

Class CommonSubs

java.lang.Object

jmri.jmrit.ctc.editor.code.CommonSubs

public class CommonSubs
extends Object

Constructor Summary

Constructors

Constructor	Description
CommonSubs()

Method Summary

Modifier and Type	Method	Description
static void	addHelpMenu(JFrame frame, String ref, boolean direct)	Add a standard help menu, including the window specific help item.
static void	addSensorToSensorList(ArrayList<NBHSensor> list, String sensorName)	Add a valid NBHSensor entry to an ArrayList.
static boolean	allowClose(Component parentComponent, boolean dataChanged)
static void	checkJComboBoxNotEmpty(JComboBox<String> combo, JLabel promptName, ArrayList<String> errors)
static void	checkJTextFieldNotEmpty(JTextField field, JLabel promptName, ArrayList<String> errors)
static int	compactDefaultTableModel(DefaultTableModel defaultTableModel)
static ArrayList<Integer>	getArrayListOfSelectableOSSectionUniqueIDs(ArrayList<CodeButtonHandlerData> codeButtonHandlerDataList)
static ArrayList<String>	getArrayListOfSelectableSwitchDirectionIndicators(ArrayList<CodeButtonHandlerData> codeButtonHandlerDataList)
static String	getCSVStringFromDefaultTableModel(DefaultTableModel defaultTableModel)
static int	getIntFromJTextFieldNoThrow(JTextField textField)
static NBHSensor	getNBHSensor(String newName, boolean isInternal)	Get a NBHSensor from the CtcManager NBHSensor map or create a new one.
static NBHSignal	getNBHSignal(String newName)	Get a NBHSignal from the CtcManager NBHSignal map or create a new one.
static NBHTurnout	getNBHTurnout(String newName, boolean feedbackDifferent)	Get a NBHTurnout from the CtcManager NBHTurnout map or create a new one.
static ArrayList<String>	getStringArrayFromDefaultTableModel(DefaultTableModel defaultTableModel)
static boolean	isJComboBoxNotEmpty(JComboBox<String> combo)
static boolean	isJTextFieldNotEmpty(JTextField field)
static boolean	missingFieldsErrorDialogDisplayed(Component parentComponent, ArrayList<String> errors, boolean isCancel)
static void	numberButtonGroup(ButtonGroup buttonGroup)
static void	populateJComboBoxWithBeans(JComboBox<String> jComboBox, String beanType, String currentSelection, boolean firstRowBlank)	Populate a combo box with bean names using getDisplayName().
static void	populateJComboBoxWithColumnDescriptions(JComboBox<String> jComboBox, CTCSerialData ctcSerialData)
static void	populateJComboBoxWithColumnDescriptionsAndSelectViaUniqueID(JComboBox<String> jComboBox, CTCSerialData ctcSerialData, int uniqueID)
static boolean	populateJComboBoxWithColumnDescriptionsExceptOurs(JComboBox<String> jComboBox, CTCSerialData ctcSerialData, int ourUniqueID, ArrayList<Integer> uniqueIDS)
static void	setButtonSelected(ButtonGroup buttonGroup, int selected)
static void	setMillisecondsEdit(JFormattedTextField formattedTextField)
static void	setSelectedIndexOfJComboBoxViaUniqueID(JComboBox<String> jComboBox, CTCSerialData ctcSerialData, int uniqueID)

Methods inherited from class java.lang.Object

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

Constructor Details

CommonSubs

public CommonSubs()

Method Details

setMillisecondsEdit

public static void setMillisecondsEdit(JFormattedTextField formattedTextField)

getIntFromJTextFieldNoThrow

public static int getIntFromJTextFieldNoThrow(JTextField textField)

allowClose

public static boolean allowClose(Component parentComponent,
 boolean dataChanged)

addHelpMenu

public static void addHelpMenu(JFrame frame,
 String ref,
 boolean direct)

Add a standard help menu, including the window specific help item.

Parameters:

frame - The frame receiving the help menu.

ref - JHelp reference for the desired window-specific help page

direct - true if the help main-menu item goes directly to the help system, such as when there are no items in the help menu

getCSVStringFromDefaultTableModel

public static String getCSVStringFromDefaultTableModel(DefaultTableModel defaultTableModel)

getStringArrayFromDefaultTableModel

public static ArrayList<String> getStringArrayFromDefaultTableModel(DefaultTableModel defaultTableModel)

compactDefaultTableModel

public static int compactDefaultTableModel(DefaultTableModel defaultTableModel)

getArrayListOfSelectableSwitchDirectionIndicators

public static ArrayList<String> getArrayListOfSelectableSwitchDirectionIndicators(ArrayList<CodeButtonHandlerData> codeButtonHandlerDataList)

getArrayListOfSelectableOSSectionUniqueIDs

public static ArrayList<Integer> getArrayListOfSelectableOSSectionUniqueIDs(ArrayList<CodeButtonHandlerData> codeButtonHandlerDataList)

populateJComboBoxWithColumnDescriptionsAndSelectViaUniqueID

public static void populateJComboBoxWithColumnDescriptionsAndSelectViaUniqueID(JComboBox<String> jComboBox,
 CTCSerialData ctcSerialData,
 int uniqueID)

populateJComboBoxWithColumnDescriptions

public static void populateJComboBoxWithColumnDescriptions(JComboBox<String> jComboBox,
 CTCSerialData ctcSerialData)

populateJComboBoxWithColumnDescriptionsExceptOurs

public static boolean populateJComboBoxWithColumnDescriptionsExceptOurs(JComboBox<String> jComboBox,
 CTCSerialData ctcSerialData,
 int ourUniqueID,
 ArrayList<Integer> uniqueIDS)

populateJComboBoxWithBeans

public static void populateJComboBoxWithBeans(JComboBox<String> jComboBox,
 String beanType,
 String currentSelection,
 boolean firstRowBlank)

Populate a combo box with bean names using getDisplayName().

If a panel xml file has not been loaded, the combo box will behave as a text field (editable), otherwise it will behave as standard combo box (not editable).

Parameters:

jComboBox - The string based combo box to be populated.

beanType - The bean type to be loaded. It has to be in the switch list.

currentSelection - The current item to be selected, none if null.

firstRowBlank - True to create a blank row. If the selection is null or empty, the blank row will be selected.

setSelectedIndexOfJComboBoxViaUniqueID

public static void setSelectedIndexOfJComboBoxViaUniqueID(JComboBox<String> jComboBox,
 CTCSerialData ctcSerialData,
 int uniqueID)

numberButtonGroup

public static void numberButtonGroup(ButtonGroup buttonGroup)

setButtonSelected

public static void setButtonSelected(ButtonGroup buttonGroup,
 int selected)

missingFieldsErrorDialogDisplayed

public static boolean missingFieldsErrorDialogDisplayed(Component parentComponent,
 ArrayList<String> errors,
 boolean isCancel)

checkJTextFieldNotEmpty

public static void checkJTextFieldNotEmpty(JTextField field,
 JLabel promptName,
 ArrayList<String> errors)

isJTextFieldNotEmpty

public static boolean isJTextFieldNotEmpty(JTextField field)

checkJComboBoxNotEmpty

public static void checkJComboBoxNotEmpty(JComboBox<String> combo,
 JLabel promptName,
 ArrayList<String> errors)

isJComboBoxNotEmpty

public static boolean isJComboBoxNotEmpty(JComboBox<String> combo)

getNBHSensor

public static NBHSensor getNBHSensor(String newName,
 boolean isInternal)

Get a NBHSensor from the CtcManager NBHSensor map or create a new one.

Parameters:

newName - The new name to be retrieved from the map or created.

isInternal - True if an internal sensor is being requested. Internal will create the sensor if necessary using provide(String).

Returns:

a NBHSensor or null.

getNBHTurnout

public static NBHTurnout getNBHTurnout(String newName,
 boolean feedbackDifferent)

Get a NBHTurnout from the CtcManager NBHTurnout map or create a new one.

Parameters:

newName - The new name to be retrieved from the map or created.

feedbackDifferent - The feedback different state.

Returns:

a valid NBHTurnout or an empty NBHTurnout.

getNBHSignal

public static NBHSignal getNBHSignal(String newName)

Get a NBHSignal from the CtcManager NBHSignal map or create a new one.

Parameters:

newName - The new name to be retrieved from the map or created.

Returns:

a valid NBHSignal or null.

addSensorToSensorList

public static void addSensorToSensorList(ArrayList<NBHSensor> list,
 String sensorName)

Add a valid NBHSensor entry to an ArrayList. The sensor name has to match an existing sensor in the JMRI sensor table.

Parameters:

list - The NBHSensor array list.

sensorName - The proposed sensor name.