VASSAL.build.module.map.LOS_Thread

All Implemented Interfaces:: MouseListener, MouseMotionListener, EventListener, AutoConfigurable, Buildable, Configurable, Drawable, PropertyNameSource, CommandEncoder, ValidityChecker, Translatable, UniqueIdManager.Identifyable

public class LOS_Thread
extends AbstractConfigurable
implements MouseListener, MouseMotionListener, Drawable, Configurable, UniqueIdManager.Identifyable, CommandEncoder

A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight). No automatic detection of obstacles is performed; the user must simply observe the thread against the image of the map. However, if the user clicks on a board with a Grid, the thread may snap to the grid and report the distance between endpoints of the line

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`LOS_Thread.GlobalOptions`
`static class`	`LOS_Thread.IconConfig`
`static class`	`LOS_Thread.LOSCommand`
`static class`	`LOS_Thread.PersistenceOptions`
`static class`	`LOS_Thread.ReportFormatConfig`
`static class`	`LOS_Thread.RoundingOptions`

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ALWAYS`
`protected Point`	`anchor`
`protected String`	`anchorLocation`
`protected Point`	`arrow`
`static String`	`CHECK_COUNT`
`static String`	`CHECK_LIST`
`protected List<String>`	`checkList`
`static String`	`CTRL_CLICK`
`protected boolean`	`ctrlWhenClick`
`static String`	`DEFAULT_ICON`
`static String`	`DRAW_RANGE`
`protected boolean`	`drawRange`
`protected String`	`fixedColor`
`static String`	`FROM_LOCATION`
`protected String`	`global`
`static String`	`GLOBAL`
`static String`	`HIDE_COUNTERS`
`static String`	`HIDE_OPACITY`
`protected boolean`	`hideCounters`
`protected int`	`hideOpacity`
`protected KeyStroke`	`hotkey`
`static String`	`HOTKEY`
`static String`	`ICON_NAME`
`protected String`	`iconName`
`protected static UniqueIdManager`	`idMgr`
`protected boolean`	`initializing`
`static String`	`LABEL`
`protected Point`	`lastAnchor`
`protected Point`	`lastArrow`
`protected String`	`lastLocation`
`protected String`	`lastRange`
`protected Rectangle`	`lastRangeRect`
`protected long`	`lastRelease`
`protected LaunchButton`	`launch`
`static String`	`LOS_COLOR`
`static String`	`LOS_THREAD_COMMAND`
`protected Map`	`map`
`protected boolean`	`mirroring`
`static String`	`NAME`
`static String`	`NEVER`
`protected String`	`persistence`
`static String`	`PERSISTENCE`
`static String`	`PERSISTENT_ICON_NAME`
`protected String`	`persistentIconName`
`protected boolean`	`persisting`
`static String`	`RANGE`
`static String`	`RANGE_BACKGROUND`
`static Font`	`RANGE_FONT`
`static String`	`RANGE_FOREGROUND`
`static String`	`RANGE_ROUNDING`
`static String`	`RANGE_SCALE`
`protected Color`	`rangeBg`
`protected Color`	`rangeFg`
`protected double`	`rangeRounding`
`protected int`	`rangeScale`
`static String`	`REPORT`
`protected FormattedString`	`reportFormat`
`protected boolean`	`retainAfterRelease`
`static String`	`ROUND_DOWN`
`static String`	`ROUND_OFF`
`static String`	`ROUND_UP`
`static String`	`SNAP_END`
`static String`	`SNAP_LOS`
`static String`	`SNAP_START`
`protected boolean`	`snapEnd`
`protected boolean`	`snapStart`
`protected Color`	`threadColor`
`protected String`	`threadId`
`static String`	`TO_LOCATION`
`static String`	`TOOLTIP`
`protected boolean`	`visible`
`static String`	`WHEN_PERSISTENT`

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor Description

LOS_Thread()

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Buildable b)`	Expects to be added to a `Map`.
`Command`	`decode(String command)`	Translate a String into a `Command`
`void`	`draw(Graphics g, Map m)`
`boolean`	`drawAboveCounters()`
`void`	`drawRange(Graphics g, int range)`	Writes text showing the range
`String`	`encode(Command c)`	Translate a `Command` into a String
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`protected Point`	`getAnchor()`
`protected Point`	`getArrow()`
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`	The attributes of an LOS_Thread are:
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the buildFile (XML) attributes of this component.
`String`	`getAttributeValueString(String key)`	Called by the `Buildable.getBuildElement(org.w3c.dom.Document)` method to write the attributes into an XML element
`VisibilityCondition`	`getAttributeVisibility(String name)`	By default, all attributes are visible
`Configurable[]`	`getConfigureComponents()`
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`String`	`getId()`
`protected int`	`getLosCheckCount()`
`protected String`	`getLosCheckList()`
`String`	`getState()`	With Global visibility, LOS_Thread now has a state that needs to be communicated to clients on other machines
`protected boolean`	`isMirroring()`
`protected boolean`	`isPersisting()`
`boolean`	`isVisible()`
`protected void`	`launch()`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseDragged(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`	Since we register ourselves as a MouseListener using `Map.pushMouseListener(java.awt.event.MouseListener)`, these mouse events are received in map coordinates
`void`	`mouseExited(MouseEvent e)`
`void`	`mouseMoved(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`void`	`removeFrom(Buildable b)`	Remove this component from its parent
`void`	`setAttribute(String key, Object value)`	Sets a buildFile (XML) attribute value for this component.
`protected void`	`setEndPoints(Point newAnchor, Point newArrow)`
`void`	`setId(String id)`	Commands controlling persistence are passed between players, so LOS Threads must have a unique ID.
`protected void`	`setMirroring(boolean b)`
`protected void`	`setPersisting(boolean b)`
`void`	`setState(String state)`
`protected void`	`setTransparency(int h)`
`void`	`setup(boolean show)`
`void`	`setVisible(boolean state)`	If true, draw the thread on the map

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

add, build, getBuildElement

Methods inherited from interface VASSAL.build.Configurable

addPropertyChangeListener, getConfigureName, getConfigurer, remove

Methods inherited from interface VASSAL.i18n.Translatable

getI18nData

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details
- LOS_THREAD_COMMAND
  
  public static final String LOS_THREAD_COMMAND
  
  See Also:
  
  Constant Field Values
- NAME
  
  public static final String NAME
  
  See Also:
  
  Constant Field Values
- SNAP_LOS
  
  public static final String SNAP_LOS
  
  See Also:
  
  Constant Field Values
- SNAP_START
  
  public static final String SNAP_START
  
  See Also:
  
  Constant Field Values
- SNAP_END
  
  public static final String SNAP_END
  
  See Also:
  
  Constant Field Values
- REPORT
  
  public static final String REPORT
  
  See Also:
  
  Constant Field Values
- PERSISTENCE
  
  public static final String PERSISTENCE
  
  See Also:
  
  Constant Field Values
- PERSISTENT_ICON_NAME
  
  public static final String PERSISTENT_ICON_NAME
  
  See Also:
  
  Constant Field Values
- GLOBAL
  
  public static final String GLOBAL
  
  See Also:
  
  Constant Field Values
- LOS_COLOR
  
  public static final String LOS_COLOR
  
  See Also:
  
  Constant Field Values
- HOTKEY
  
  public static final String HOTKEY
  
  See Also:
  
  Constant Field Values
- TOOLTIP
  
  public static final String TOOLTIP
  
  See Also:
  
  Constant Field Values
- ICON_NAME
  
  public static final String ICON_NAME
  
  See Also:
  
  Constant Field Values
- LABEL
  
  public static final String LABEL
  
  See Also:
  
  Constant Field Values
- DRAW_RANGE
  
  public static final String DRAW_RANGE
  
  See Also:
  
  Constant Field Values
- HIDE_COUNTERS
  
  public static final String HIDE_COUNTERS
  
  See Also:
  
  Constant Field Values
- HIDE_OPACITY
  
  public static final String HIDE_OPACITY
  
  See Also:
  
  Constant Field Values
- RANGE_BACKGROUND
  
  public static final String RANGE_BACKGROUND
  
  See Also:
  
  Constant Field Values
- RANGE_FOREGROUND
  
  public static final String RANGE_FOREGROUND
  
  See Also:
  
  Constant Field Values
- RANGE_SCALE
  
  public static final String RANGE_SCALE
  
  See Also:
  
  Constant Field Values
- RANGE_ROUNDING
  
  public static final String RANGE_ROUNDING
  
  See Also:
  
  Constant Field Values
- ROUND_UP
  
  public static final String ROUND_UP
  
  See Also:
  
  Constant Field Values
- ROUND_DOWN
  
  public static final String ROUND_DOWN
  
  See Also:
  
  Constant Field Values
- ROUND_OFF
  
  public static final String ROUND_OFF
  
  See Also:
  
  Constant Field Values
- RANGE_FONT
  
  public static Font RANGE_FONT
- DEFAULT_ICON
  
  public static final String DEFAULT_ICON
  
  See Also:
  
  Constant Field Values
- FROM_LOCATION
  
  public static final String FROM_LOCATION
  
  See Also:
  
  Constant Field Values
- TO_LOCATION
  
  public static final String TO_LOCATION
  
  See Also:
  
  Constant Field Values
- CHECK_COUNT
  
  public static final String CHECK_COUNT
  
  See Also:
  
  Constant Field Values
- CHECK_LIST
  
  public static final String CHECK_LIST
  
  See Also:
  
  Constant Field Values
- RANGE
  
  public static final String RANGE
  
  See Also:
  
  Constant Field Values
- NEVER
  
  public static final String NEVER
  
  See Also:
  
  Constant Field Values
- ALWAYS
  
  public static final String ALWAYS
  
  See Also:
  
  Constant Field Values
- CTRL_CLICK
  
  public static final String CTRL_CLICK
  
  See Also:
  
  Constant Field Values
- WHEN_PERSISTENT
  
  public static final String WHEN_PERSISTENT
  
  See Also:
  
  Constant Field Values
- idMgr
  
  protected static UniqueIdManager idMgr
- retainAfterRelease
  
  protected boolean retainAfterRelease
- lastRelease
  
  protected long lastRelease
- map
  
  protected Map map
- launch
  
  protected LaunchButton launch
- hotkey
  
  protected KeyStroke hotkey
- anchor
  
  protected Point anchor
- arrow
  
  protected Point arrow
- visible
  
  protected boolean visible
- drawRange
  
  protected boolean drawRange
- rangeScale
  
  protected int rangeScale
- rangeRounding
  
  protected double rangeRounding
- hideCounters
  
  protected boolean hideCounters
- hideOpacity
  
  protected int hideOpacity
- fixedColor
  
  protected String fixedColor
- threadColor
  
  protected Color threadColor
- rangeFg
  
  protected Color rangeFg
- rangeBg
  
  protected Color rangeBg
- snapStart
  
  protected boolean snapStart
- snapEnd
  
  protected boolean snapEnd
- lastAnchor
  
  protected Point lastAnchor
- lastArrow
  
  protected Point lastArrow
- lastRangeRect
  
  protected Rectangle lastRangeRect
- anchorLocation
  
  protected String anchorLocation
- lastLocation
  
  protected String lastLocation
- lastRange
  
  protected String lastRange
- reportFormat
  
  protected FormattedString reportFormat
- checkList
  
  protected List<String> checkList
- persistence
  
  protected String persistence
- persistentIconName
  
  protected String persistentIconName
- global
  
  protected String global
- threadId
  
  protected String threadId
- persisting
  
  protected boolean persisting
- mirroring
  
  protected boolean mirroring
- iconName
  
  protected String iconName
- ctrlWhenClick
  
  protected boolean ctrlWhenClick
- initializing
  
  protected boolean initializing
Constructor Details
- LOS_Thread
  
  public LOS_Thread()
Method Details
- isVisible
  
  public boolean isVisible()
  
  Returns:
  
  whether the thread should be drawn
- setVisible
  
  public void setVisible(boolean state)
  
  If true, draw the thread on the map
- addTo
  
  public void addTo(Buildable b)
  
  Expects to be added to a Map. Adds a button to the map window's toolbar. Pushing the button pushes a MouseListener onto the Map that draws the thread. Adds some entries to preferences
  
  Specified by:
  
  addTo in interface Buildable
  
  See Also:
  
  Map.pushMouseListener(java.awt.event.MouseListener)
- removeFrom
  
  public void removeFrom(Buildable b)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- getAttributeNames
  
  public String[] getAttributeNames()
  The attributes of an LOS_Thread are:
  NAME: the name of the Preferences tab LABEL: the label of the button HOTKEY: the hotkey equivalent of the button DRAW_RANGE: If true, draw the distance between endpoints of the thread RANGE_FOREGROUND: the color of the text when drawing the distance RANGE_BACKGROUND: the color of the background rectangle when drawing the distance HIDE_COUNTERS: If true, hide all GamePieces on the map when drawing the thread
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all buildFile (XML) attribute names for this component
- setAttribute
  
  public void setAttribute(String key, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
  
  Specified by:
  
  setAttribute in interface AutoConfigurable
  
  Specified by:
  
  setAttribute in interface Translatable
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
  
  value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
- setTransparency
  
  protected void setTransparency(int h)
- getAttributeValueString
  
  public String getAttributeValueString(String key)
  
  Description copied from interface: AutoConfigurable
  
  Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
  
  Returns:
  
  a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
- setup
  
  public void setup(boolean show)
- getState
  
  public String getState()
  
  With Global visibility, LOS_Thread now has a state that needs to be communicated to clients on other machines
- setState
  
  public void setState(String state)
- draw
  
  public void draw(Graphics g, Map m)
  
  Specified by:
  
  draw in interface Drawable
- drawAboveCounters
  
  public boolean drawAboveCounters()
  
  Specified by:
  
  drawAboveCounters in interface Drawable
- launch
  
  protected void launch()
- setId
  
  public void setId(String id)
  
  Commands controlling persistence are passed between players, so LOS Threads must have a unique ID.
  
  Specified by:
  
  setId in interface UniqueIdManager.Identifyable
- getId
  
  public String getId()
  
  Specified by:
  
  getId in interface UniqueIdManager.Identifyable
- mouseEntered
  
  public void mouseEntered(MouseEvent e)
  
  Since we register ourselves as a MouseListener using Map.pushMouseListener(java.awt.event.MouseListener), these mouse events are received in map coordinates
  
  Specified by:
  
  mouseEntered in interface MouseListener
- mouseExited
  
  public void mouseExited(MouseEvent e)
  
  Specified by:
  
  mouseExited in interface MouseListener
- mouseClicked
  
  public void mouseClicked(MouseEvent e)
  
  Specified by:
  
  mouseClicked in interface MouseListener
- mousePressed
  
  public void mousePressed(MouseEvent e)
  
  Specified by:
  
  mousePressed in interface MouseListener
- mouseReleased
  
  public void mouseReleased(MouseEvent e)
  
  Specified by:
  
  mouseReleased in interface MouseListener
- setPersisting
  
  protected void setPersisting(boolean b)
- isPersisting
  
  protected boolean isPersisting()
- setMirroring
  
  protected void setMirroring(boolean b)
- isMirroring
  
  protected boolean isMirroring()
- getAnchor
  
  protected Point getAnchor()
- setEndPoints
  
  protected void setEndPoints(Point newAnchor, Point newArrow)
- getArrow
  
  protected Point getArrow()
- getLosCheckCount
  
  protected int getLosCheckCount()
- getLosCheckList
  
  protected String getLosCheckList()
- mouseMoved
  
  public void mouseMoved(MouseEvent e)
  
  Specified by:
  
  mouseMoved in interface MouseMotionListener
- mouseDragged
  
  public void mouseDragged(MouseEvent e)
  
  Specified by:
  
  mouseDragged in interface MouseMotionListener
- drawRange
  
  public void drawRange(Graphics g, int range)
  
  Writes text showing the range
  
  Parameters:
  
  range - the range to display, in whatever units returned by the MapGrid containing the thread
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from interface: AutoConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
  
  Returns:
  
  an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- getAttributeVisibility
  
  public VisibilityCondition getAttributeVisibility(String name)
  
  Description copied from class: AbstractConfigurable
  
  By default, all attributes are visible
  
  Specified by:
  
  getAttributeVisibility in interface AutoConfigurable
  
  Overrides:
  
  getAttributeVisibility in class AbstractConfigurable
  
  Parameters:
  
  name - Name (key) of one of this component's attributes
  
  Returns:
  
  a VisibilityCondition for this attribute, or null if attribute should always be visible.
- getConfigureComponents
  
  public Configurable[] getConfigureComponents()
  
  Specified by:
  
  getConfigureComponents in interface Configurable
  
  Overrides:
  
  getConfigureComponents in class AbstractConfigurable
  
  Returns:
  
  A list of all child components (i.e. subcomponents) of this component that are configurable.
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Configuration Window.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
- decode
  
  public Command decode(String command)
  
  Description copied from interface: CommandEncoder
  
  Translate a String into a Command
  
  Specified by:
  
  decode in interface CommandEncoder
- encode
  
  public String encode(Command c)
  
  Description copied from interface: CommandEncoder
  
  Translate a Command into a String
  
  Specified by:
  
  encode in interface CommandEncoder

Class LOS_Thread

Nested Class Summary

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

Field Summary

Fields inherited from class VASSAL.build.AbstractConfigurable

Fields inherited from class VASSAL.build.AbstractBuildable

Fields inherited from interface VASSAL.build.Configurable

Constructor Summary

Method Summary

Methods inherited from class VASSAL.build.AbstractConfigurable

Methods inherited from class VASSAL.build.AbstractBuildable

Methods inherited from class java.lang.Object

Methods inherited from interface VASSAL.build.Buildable

Methods inherited from interface VASSAL.build.Configurable

Methods inherited from interface VASSAL.i18n.Translatable

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

Field Details

LOS_THREAD_COMMAND

NAME

SNAP_LOS

SNAP_START

SNAP_END

REPORT

PERSISTENCE

PERSISTENT_ICON_NAME

GLOBAL

LOS_COLOR

HOTKEY

TOOLTIP

ICON_NAME

LABEL

DRAW_RANGE

HIDE_COUNTERS

HIDE_OPACITY

RANGE_BACKGROUND

RANGE_FOREGROUND

RANGE_SCALE

RANGE_ROUNDING

ROUND_UP

ROUND_DOWN

ROUND_OFF

RANGE_FONT

DEFAULT_ICON

FROM_LOCATION

TO_LOCATION

CHECK_COUNT

CHECK_LIST

RANGE

NEVER

ALWAYS

CTRL_CLICK

WHEN_PERSISTENT

idMgr

retainAfterRelease

lastRelease

map

launch

hotkey

anchor

arrow

visible

drawRange

rangeScale

rangeRounding

hideCounters

hideOpacity

fixedColor

threadColor

rangeFg

rangeBg

snapStart

snapEnd

lastAnchor

lastArrow

lastRangeRect

anchorLocation

lastLocation

lastRange

reportFormat

checkList