Package jmri.web.servlet.operations

Class HtmlTrainCommon

java.lang.Object

jmri.jmrit.operations.trains.trainbuilder.TrainCommon

jmri.web.servlet.operations.HtmlTrainCommon

Direct Known Subclasses:

HtmlConductor, HtmlManifest

public class HtmlTrainCommon
extends TrainCommon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	HtmlTrainCommon.ShowLocation

Field Summary

Fields

Modifier and Type	Field	Description
protected final Locale	locale
protected String	resourcePrefix
protected final Properties	strings
protected final Train	train

Fields inherited from class jmri.jmrit.operations.trains.trainbuilder.TrainCommon

_dropCars, _pickupCars, BLANK_LINE, BUILD_REPORT_CHAR, carManager, ENGINE, engineManager, HORIZONTAL_LINE_CHAR, HYPHEN, IS_MANIFEST, IS_TWO_COLUMN_TRACK, LOCAL, locationManager, NEW_LINE, PAPER_MARGINS, PICKUP, SPACE, TAB, TEXT_COLOR_DONE, TEXT_COLOR_END, TEXT_COLOR_START, VERTICAL_LINE_CHAR

Constructor Summary

Constructors

Constructor	Description
HtmlTrainCommon(Locale locale, Train train)

Method Summary

Modifier and Type	Method	Description
static String	convertToHTMLColor(String text)
protected String	dropCar(Car car, int count, String[] format, boolean isLocal)
protected String	dropCar(Car car, String[] format, boolean isLocal)
String	dropEngine(Engine engine)	Returns the drop string for a loco.
protected String	dropEngines(List<Engine> engines, RouteLocation location)
protected String	engineChange(RouteLocation rl, int legOptions)
protected String	getCarAttribute(Car car, String attribute, boolean isPickup, boolean isLocal)
protected String	getEngineAttribute(Engine engine, String attribute, boolean isPickup)
protected String	getRollingStockAttribute(RollingStock rs, String attribute, boolean isPickup, boolean isLocal)
protected String	getTrackComments(RouteLocation location, List<Car> cars)
String	getValidity()
protected String	pickUpCar(Car car, int count, String[] format)
protected String	pickUpCar(Car car, String[] format)
String	pickupEngine(Engine engine)	Returns the pick up string for a loco.
protected String	pickupEngines(List<Engine> engines, RouteLocation location)
String	pickupUtilityCars(List<Car> cars, Car car, boolean isManifest)
protected String	setoutUtilityCars(List<Car> cars, Car car, boolean isManifest)

Methods inherited from class jmri.jmrit.operations.trains.trainbuilder.TrainCommon

addCarsLocationUnknown, addLine, addLine, blockCarsByTrack, blockCarsByTrackNameTwoColumn, blockCarsTwoColumn, blockLocosTwoColumn, clearUtilityCarTypes, convertStringTime, convertStringToDate, countPickupUtilityCars, countSetoutUtilityCars, countUtilityCars, createTabIfNeeded, dropCar, dropCar, dropEngines, formatColorString, formatStringToCommaSeparated, getDate, getDate, getDropCarHeader, getDropEngineHeader, getISO8601Date, getLineLength, getLocalMoveHeader, getManifestHeaderLineLength, getPageSize, getPickupCarHeader, getPickupEngineHeader, getSwitchListTrainStatus, getTextColor, getTextColorName, getTextColorString, getTrainMessage, isNextCar, isNextCar, isThereWorkAtLocation, isThereWorkAtLocation, localMoveCar, newLine, newLine, padAndTruncate, padAndTruncateIfNeeded, padString, pickupCar, pickUpCar, pickUpCarTruncated, pickupEngines, pickupUtilityCars, pickupUtilityCars, printCarHeader, printDropCarHeader, printDropEngineHeader, printEngineHeader, printHorizontalLine, printHorizontalLine, printHorizontalLine1, printHorizontalLine2, printHorizontalLine3, printLocalCarMoveHeader, printPickupCarHeader, printPickupEngineHeader, printTrackComments, printTrackNameHeader, setCarPickupAndSetoutTimes, setoutUtilityCars, setoutUtilityCars, setoutUtilityCars, splitString, splitStringLeftParenthesis, tabString, truncatedDropCar

Methods inherited from class java.lang.Object

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

Field Details

strings

protected final Properties strings

locale

protected final Locale locale

train

protected final Train train

resourcePrefix

protected String resourcePrefix

Constructor Details

HtmlTrainCommon

public HtmlTrainCommon(Locale locale,
 Train train)
                throws IOException

Throws:

IOException

Method Details

pickupUtilityCars

public String pickupUtilityCars(List<Car> cars,
 Car car,
 boolean isManifest)

setoutUtilityCars

protected String setoutUtilityCars(List<Car> cars,
 Car car,
 boolean isManifest)

pickUpCar

protected String pickUpCar(Car car,
 String[] format)

pickUpCar

protected String pickUpCar(Car car,
 int count,
 String[] format)

dropCar

protected String dropCar(Car car,
 String[] format,
 boolean isLocal)

dropCar

protected String dropCar(Car car,
 int count,
 String[] format,
 boolean isLocal)

engineChange

protected String engineChange(RouteLocation rl,
 int legOptions)

dropEngines

protected String dropEngines(List<Engine> engines,
 RouteLocation location)

dropEngine

public String dropEngine(Engine engine)

Description copied from class: TrainCommon

Returns the drop string for a loco. Useful for frames like the train conductor and yardmaster.

Overrides:

dropEngine in class TrainCommon

Parameters:

engine - The Engine.

Returns:

engine drop string

pickupEngines

protected String pickupEngines(List<Engine> engines,
 RouteLocation location)

pickupEngine

public String pickupEngine(Engine engine)

Description copied from class: TrainCommon

Returns the pick up string for a loco. Useful for frames like the train conductor and yardmaster.

Overrides:

pickupEngine in class TrainCommon

Parameters:

engine - The Engine.

Returns:

engine pick up string

getCarAttribute

protected String getCarAttribute(Car car,
 String attribute,
 boolean isPickup,
 boolean isLocal)

getEngineAttribute

protected String getEngineAttribute(Engine engine,
 String attribute,
 boolean isPickup)

getRollingStockAttribute

protected String getRollingStockAttribute(RollingStock rs,
 String attribute,
 boolean isPickup,
 boolean isLocal)

getTrackComments

protected String getTrackComments(RouteLocation location,
 List<Car> cars)

getValidity

public String getValidity()

convertToHTMLColor

public static String convertToHTMLColor(String text)

Parameters:

text - Text with color tags needing conversion. See TrainCommon.formatColorString(String text, Color color) Also converts line feeds to HTLM

Returns:

HTML text with style color option