Package megameklab.printing

Class PrintSmallUnitSheet

java.lang.Object

megameklab.printing.PrintRecordSheet

megameklab.printing.PrintSmallUnitSheet

All Implemented Interfaces:

Printable, IdConstants

public class PrintSmallUnitSheet
extends PrintRecordSheet

Lays out a record sheet for infantry, BA, or protoMeks

Field Summary

Fields inherited from class megameklab.printing.PrintRecordSheet

DEFAULT_PIP_SIZE, DEFAULT_PIP_STROKE, DEFAULT_TYPEFACE, FILL_BLACK, FILL_GREY, FILL_RED, FILL_SHADOW, FILL_WHITE, FONT_SIZE_LARGE, FONT_SIZE_MEDIUM, FONT_SIZE_SMALL, FONT_SIZE_VERY_SMALL, options, svgNS, TABLE_RATIO

Fields inherited from interface megameklab.printing.IdConstants

AFT_HEAT, AFT_SIDES_HEAT, AMMO_PIPS, ARMOR_DIAGRAM, ARMOR_DIVISOR, ARMOR_KIT, ARMOR_PIPS, ARMOR_TYPE, ASF_BLANK_GUNNERY_SKILL, ASF_BLANK_PILOTING_SKILL, ASF_GUNNERY_SKILL, ASF_PILOTING_SKILL, AVIONICS_HIT, BLANK_CREW_NAME, BLANK_GUNNERY_SKILL, BLANK_PILOTING_SKILL, BLANKS_CREW, BOMB_BOXES, BROADSIDES_HEAT, BV, CANON_ARMOR_PIPS, CANON_STRUCTURE_PIPS, CHECK_AP, CHECK_LEG, CHECK_MECHANIZED, CHECK_SWARM, CIC_HIT, COMMANDER_HIT, COPILOT_HIT, COPYRIGHT, COST, CREW_DAMAGE, CREW_HIT, CREW_NAME, CRITS, DAMAGE, DC_PIPS, DEFAULT_FLUFF_IMAGE, DEST_MODS, DOCKING_COLLAR_HIT, DOUBLE_HS_COUNT, DRIVER_HIT, ENGINE_HIT, ENGINE_TYPE, ERA_ICON, EXTERNAL_STORES, EXTERNAL_STORES_KEY, FCS_HIT, FIELD_GUN_AMMO, FIELD_GUN_COLUMNS, FIELD_GUN_CREW, FIELD_GUN_DMG, FIELD_GUN_DMG_2, FIELD_GUN_LONG, FIELD_GUN_MED, FIELD_GUN_MIN_RANGE, FIELD_GUN_QTY, FIELD_GUN_SHORT, FIELD_GUN_TYPE, FLIGHT_STABILIZER_HIT, FLUFF_DUAL_PILOT, FLUFF_IMAGE, FLUFF_NAME, FLUFF_SINGLE_PILOT, FLUFF_TRIPLE_PILOT, FOOTER, FORE_SIDES_HEAT, FRAME, FUEL_TANK_HIT, GUNNERY_SKILL, GUNNERY_SKILL_TEXT, GYRO_HIT, HEAT_SINK_PIPS, HEAVY_DUTY_GYRO_PIP, HS_COUNT, HS_TYPE, INVENTORY, IS_PIPS, IS_PIPS_HD, IS_PIPS_HD_SH, KF_BOOM_HIT, KF_PIPS, LANDING_GEAR_HIT, LBL_BATTLEARMOR, LBL_JUMP, LBL_ROLE, LBL_VEE_MODE, LIFE_BOATS, LIFE_SUPPORT_HIT, MAG_CLAMP_NOTE, MAIN_GUN_ARMOR, MAIN_GUN_SHADOW, MAIN_GUN_TEXT, MINUS_1_MP, MINUS_2_MP, MINUS_3_MP, MINUS_4_MP, MINUS_5_MP, MINUS_6_MP, MINUS_7_MP, MINUS_8_MP, MINUS_9_MP, MML_COLOR_ELEMENTS, MML_FIELD_WIDTH, MML_GAP, MML_MULTISECTION, MODE_1, MODE_2, MODE_2_LABEL, MOTIVE_SYSTEM_HIT, MOVEMENT_TYPE, MP_1, MP_2, MP_2_LABEL, MP_AIR_MEK_CRUISE, MP_AIR_MEK_FLANK, MP_AIR_MEK_RUN, MP_AIR_MEK_WALK, MP_CRUISE, MP_FLANK, MP_GROUND, MP_JUMP, MP_MAX_THRUST, MP_RUN, MP_SAFE_THRUST, MP_WALK, N_BATTLEARMOR, N_CREW, N_MARINES, N_OTHER, N_PASSENGERS, NO_SOLDIER, NOSE_HEAT, NOTES, PARTIAL_WING_BONUS, PATCHWORK, PILOT_HIT, PILOT_NAME, PILOTING_SKILL, PILOTING_SKILL_TEXT, PIPS, PROTOMEK_INDEX, RANGE, RANGE_IN_HEXES, RANGE_MOD, ROLE, ROW_SHADING, RS_TEMPLATE, RULES_LEVEL, SAIL_PIPS, SENSOR_HIT, SHIELD, SHIELD_DA, SHIELD_DC, SI_PIPS, SNEAK_CAMO_MODS, SNEAK_IR_MODS, SOLDIER, SPAS, SQUAD, STABILIZER_HIT_FRONT, STABILIZER_HIT_LEFT, STABILIZER_HIT_REAR, STABILIZER_HIT_RIGHT, STABILIZER_HIT_TURRET, STABILIZER_HIT_TURRET_FRONT, STABILIZER_HIT_TURRET_REAR, STRUCTURE_PIPS, STRUCTURE_TYPE, SUIT, TECH_BASE, TEXT_ARMOR, TEXT_DOCKING_COLLARS, TEXT_IS, TEXT_KF_DRIVE, TEXT_SAIL, TEXT_SI, THRUSTER_LEFT_HIT, THRUSTER_RIGHT_HIT, TITLE, TONNAGE, TORSO_WEAPON, TRACKS, TRANSPORT_WT, TURRET_LOCKED, TURRET_LOCKED_FRONT, TURRET_LOCKED_REAR, TYPE, TYPE2, UNIT_SCALE, UNIT_TYPE, UW_LABEL, UW_RANGE_MOD, WARRIOR_DATA_DUAL, WARRIOR_DATA_SINGLE, WARRIOR_DATA_TRIPLE, WHEELS

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor	Description
PrintSmallUnitSheet(Collection<? extends megamek.common.units.Entity> entities, int startPage, RecordSheetOptions options)	Create a record sheet for two vehicles, or one vehicle and tables.

Method Summary

Modifier and Type	Method	Description
protected void	addReferenceCharts(PageFormat pageFormat)	Adds reference charts to the right side of the record sheet.
static boolean	fillsSheet(List<? extends megamek.common.units.Entity> entities, RecordSheetOptions options)
static boolean	fillsSheet(List<? extends megamek.common.units.Entity> entities, RecordSheetOptions options, int desiredExtraEmptySlots)	Determines if the supplied list of units fills the sheet or if there's room for more
List<String>	getBookmarkNames()	Used to build an outline of a PDF document
protected String	getRecordSheetTitle()
protected List<ReferenceTable>	getRightSideReferenceTables()
protected String	getSVGFileName(int pageNumber)
protected boolean	includeReferenceCharts()	Used to determine whether to scale the record sheet to make room for charts.
protected void	processImage(int startPage, PageFormat pageFormat)	Renders the sheet to the Graphics object.

Methods inherited from class megameklab.printing.PrintRecordSheet

addLineThrough, addLineThrough, addMultilineTextElement, addMultilineTextElement, addMultilineTextElement, addTextElement, addTextElement, addTextElement, addTextElementToFit, addTextElementToFit, addTextElementToFit, applyCoreComponentsCriticalDamage, build, createDocument, createDocument, createPip, createPip, createPip, createRoundedRectangle, embedImage, embedImage, exportPDF, fillCoreComponentCriticalDamage, fillCoreComponentCriticalDamage, getBoldFont, getBoldItalicFont, getBoldItalicTextLength, getBoldTextLength, getDamageFillColor, getFirstPage, getFontHeight, getFontHeight, getItalicFont, getItalicTextLength, getNormalFont, getNormalTextLength, getPageCount, getRectBBox, getSVGDocument, getTextLength, getTextLength, getTextLength, getTypeface, hideElement, hideElement, hideElement, hideElement, loadTemplate, loadTemplate, placeReferenceCharts, print, removeElement, setCallback, setSVGDocument, setTextField, setTextField, setTextField

Methods inherited from class java.lang.Object

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

Constructor Details

PrintSmallUnitSheet

public PrintSmallUnitSheet(Collection<? extends megamek.common.units.Entity> entities,
 int startPage,
 RecordSheetOptions options)

Create a record sheet for two vehicles, or one vehicle and tables.

Parameters:

entities - The units to print

startPage - The index of this page in the print job

options - Options for printing

Method Details

getBookmarkNames

public List<String> getBookmarkNames()

Description copied from class: PrintRecordSheet

Used to build an outline of a PDF document

Specified by:

getBookmarkNames in class PrintRecordSheet

Returns:

Names of outline entries

processImage

protected void processImage(int startPage,
 PageFormat pageFormat)

Description copied from class: PrintRecordSheet

Renders the sheet to the Graphics object.

Overrides:

processImage in class PrintRecordSheet

Parameters:

startPage - Indicates which page of multipage sheets to print. The first page is 0.

getSVGFileName

protected String getSVGFileName(int pageNumber)

Specified by:

getSVGFileName in class PrintRecordSheet

Parameters:

pageNumber - The page number in the current record sheet, where the first page is numbered zero.

Returns:

The file name for the current page in the record sheet image directory

getRecordSheetTitle

protected String getRecordSheetTitle()

Specified by:

getRecordSheetTitle in class PrintRecordSheet

Returns:

The title to use for the record sheet

includeReferenceCharts

protected boolean includeReferenceCharts()

Description copied from class: PrintRecordSheet

Used to determine whether to scale the record sheet to make room for charts. This depends both on whether the option is selected and on whether the sheet supports reference charts.

Overrides:

includeReferenceCharts in class PrintRecordSheet

Returns:

Whether to include reference tables

getRightSideReferenceTables

protected List<ReferenceTable> getRightSideReferenceTables()

Overrides:

getRightSideReferenceTables in class PrintRecordSheet

addReferenceCharts

protected void addReferenceCharts(PageFormat pageFormat)

Description copied from class: PrintRecordSheet

Adds reference charts to the right side of the record sheet.

Overrides:

addReferenceCharts in class PrintRecordSheet

Parameters:

pageFormat - The document's page format.

fillsSheet

public static boolean fillsSheet(List<? extends megamek.common.units.Entity> entities,
 RecordSheetOptions options)

fillsSheet

public static boolean fillsSheet(List<? extends megamek.common.units.Entity> entities,
 RecordSheetOptions options,
 int desiredExtraEmptySlots)

Determines if the supplied list of units fills the sheet or if there's room for more

Parameters:

entities - The list of entities to place on the sheet

options - The record sheet options, as reference tables can reduce available space

Returns:

true if no more entities can be printed on a single sheet