Package VASSAL.build.module.map

Class CounterDetailViewer

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.CounterDetailViewer

All Implemented Interfaces:

DragSourceMotionListener, KeyListener, MouseListener, MouseMotionListener, EventListener, AutoConfigurable, Buildable, Configurable, Drawable, PropertyNameSource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget

Direct Known Subclasses:

GlobalMap.CounterViewer

public class CounterDetailViewer
extends AbstractConfigurable
implements Drawable, DragSourceMotionListener, MouseMotionListener, MouseListener, KeyListener

This is a Drawable class that draws the counters horizontally when the mouse is held over a stack with the control key down.

Version:

1.0

Author:

David Sullivan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CounterDetailViewer.CounterFormatConfig
static class	CounterDetailViewer.DisplayConfig
static class	CounterDetailViewer.EmptyFormatConfig
protected class	CounterDetailViewer.Filter	Utility class to select the pieces we wish to view.
static class	CounterDetailViewer.MinConfig
static class	CounterDetailViewer.ReportFormatConfig
protected static class	CounterDetailViewer.Visitor

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL_LAYERS
static String	ALWAYS_SHOW_LOC	Deprecated, for removal: This API element is subject to removal in a future version.
protected boolean	alwaysShowLoc	Deprecated, for removal: This API element is subject to removal in a future version.
static String	BG_COLOR
protected Color	bgColor
static String	BORDER_WIDTH
protected int	borderWidth
protected Rectangle	bounds
static String	CENTER_ALL
static String	CENTER_TEXT
protected boolean	centerAll
protected boolean	centerText
static String	COMBINE_COUNTER_SUMMARY
protected boolean	combineCounterSummary
static String	COUNTER_REPORT_FORMAT
protected FormattedString	counterReportFormat
protected MouseEvent	currentMousePosition
protected int	delay
static String	DELAY
protected Timer	delayTimer
protected String	desc
static String	DESCRIPTION
static String	DISPLAY
protected List<GamePiece>	displayablePieces
protected String[]	displayLayers
protected String	displayWhat
static String	DRAW_PIECES
static String	DRAW_PIECES_AT_ZOOM
protected boolean	drawPieces
protected boolean	drawSingleDeprecated
static String	EMPTY_HEX_REPORT_FORMAT
protected FormattedString	emptyHexReportFormat
static String	ENABLE_HTML
protected boolean	enableHTML
static String	EXC_LAYERS
static String	EXTRA_TEXT_PADDING
protected int	extraTextPadding
static String	FG_COLOR
protected Color	fgColor
static String	FILTER
protected Font	font
static String	FONT_SIZE
protected int	fontSize
static String	GRAPH_SINGLE_DEPRECATED
protected boolean	graphicsVisible
protected double	graphicsZoomLevel
protected KeyStroke	hotkey
static String	HOTKEY
static String	INC_LAYERS
protected Rectangle	lastPieceBounds
static String	LATEST_VERSION
static String	LAYER_LIST
protected Map	map
static String	MINIMUM_DISPLAYABLE
protected int	minimumDisplayablePieces
protected boolean	mouseInView
static String	PREFERRED_DELAY
static String	PROPERTY_FILTER
protected PropertyExpression	propertyFilter
static String	SHOW_DECK
static String	SHOW_DECK_DEPTH
static String	SHOW_MOVE_SELECTED
static String	SHOW_NON_MOVABLE
static String	SHOW_NOSTACK
static String	SHOW_OVERLAP
static String	SHOW_TEXT
static String	SHOW_TEXT_SINGLE_DEPRECATED
protected boolean	showDeck
protected static int	showDeckDepth
protected boolean	showMoveSelected
protected boolean	showNonMovable
protected boolean	showNoStack
protected boolean	showOverlap
protected boolean	showText
protected boolean	showTextSingleDeprecated
static String	STRETCH_WIDTH_SUMMARY
protected boolean	stretchWidthSummary
static String	SUM
static String	SUMMARY_REPORT_FORMAT
protected FormattedString	summaryReportFormat
protected boolean	textVisible
static String	TOP_LAYER
static String	UNROTATE_PIECES
protected boolean	unrotatePieces
static String	USE_KEYBOARD
protected String	version
static String	VERSION
static String	VERTICAL_OFFSET
static String	VERTICAL_TOP_TEXT
protected int	verticalOffset
protected int	verticalTopText
protected JComponent	view	the JComponent which is repainted when the detail viewer changes
static String	ZOOM_LEVEL
protected double	zoomLevel

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
CounterDetailViewer()

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	In case our labels refer to any image files
void	addTo(Buildable b)	Adds this component to its parent.
void	dragMouseMoved(DragSourceDragEvent e)
void	draw(Graphics g, Point pt, JComponent comp)
void	draw(Graphics g, Map map)
boolean	drawAboveCounters()
protected void	drawGraphics(Graphics g, Point pt, JComponent comp, List<GamePiece> pieces)
protected void	drawGraphics(Graphics g, Point pt, JComponent comp, PieceIterator pi)	Deprecated, for removal: This API element is subject to removal in a future version. Use drawGraphics(Graphics, Point, JComponent, List)
protected void	drawLabel(Graphics g, Point pt, String label)	Deprecated, for removal: This API element is subject to removal in a future version. Use {drawLabel(Graphics, Point, String, int, int)}
protected void	drawLabel(Graphics g, Point pt, String label, int hAlign, int vAlign)
protected void	drawLabel(Graphics g, Point pt, String label, int hAlign, int vAlign, int objectWidth, int minWidth, int extraBorder, boolean skipBox)	Next, we go to this intermediate method, which deals with a couple of things (like deciding whether we're drawing in HTML mode or not) and then calls the LabelUtils to do the Hard Work.
protected void	drawText(Graphics g, Point pt, JComponent comp, List<GamePiece> pieces)	Label with the location If the counter viewer is being displayed, then place the location name just above the left hand end of the counters.
protected void	drawText(Graphics g, Point pt, JComponent comp, PieceIterator pi)	Deprecated, for removal: This API element is subject to removal in a future version. Use drawText(Graphics, Point, JComponent, List)
protected void	fixBounds(List<GamePiece> pieces)	Set the bounds field large enough to accommodate the given set of pieces
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String name)	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
protected Rectangle	getBounds(GamePiece piece)
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
protected List<GamePiece>	getDisplayablePieces()	Build an ArrayList of pieces to be displayed in order from bottom up, based on selection criteria setup in config.
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
protected int	getPreferredDelay()
protected double	getZoom()
protected void	hideDetails()
protected boolean	isTextUnderCounters()
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.
protected void	showDetails()
protected void	upgrade()

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getPropertyList, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

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

build, getBuildElement

Field Details

LATEST_VERSION

public static final String LATEST_VERSION

See Also:

Constant Field Values

USE_KEYBOARD

public static final String USE_KEYBOARD

See Also:

Constant Field Values

PREFERRED_DELAY

public static final String PREFERRED_DELAY

See Also:

Constant Field Values

DELAY

public static final String DELAY

See Also:

Constant Field Values

ALWAYS_SHOW_LOC

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static final String ALWAYS_SHOW_LOC

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

DRAW_PIECES

public static final String DRAW_PIECES

See Also:

Constant Field Values

GRAPH_SINGLE_DEPRECATED

public static final String GRAPH_SINGLE_DEPRECATED

See Also:

Constant Field Values

MINIMUM_DISPLAYABLE

public static final String MINIMUM_DISPLAYABLE

See Also:

Constant Field Values

HOTKEY

public static final String HOTKEY

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

CENTER_TEXT

public static final String CENTER_TEXT

See Also:

Constant Field Values

CENTER_ALL

public static final String CENTER_ALL

See Also:

Constant Field Values

COMBINE_COUNTER_SUMMARY

public static final String COMBINE_COUNTER_SUMMARY

See Also:

Constant Field Values

VERTICAL_OFFSET

public static final String VERTICAL_OFFSET

See Also:

Constant Field Values

VERTICAL_TOP_TEXT

public static final String VERTICAL_TOP_TEXT

See Also:

Constant Field Values

STRETCH_WIDTH_SUMMARY

public static final String STRETCH_WIDTH_SUMMARY

See Also:

Constant Field Values

SHOW_TEXT

public static final String SHOW_TEXT

See Also:

Constant Field Values

ENABLE_HTML

public static final String ENABLE_HTML

See Also:

Constant Field Values

SHOW_TEXT_SINGLE_DEPRECATED

public static final String SHOW_TEXT_SINGLE_DEPRECATED

See Also:

Constant Field Values

ZOOM_LEVEL

public static final String ZOOM_LEVEL

See Also:

Constant Field Values

DRAW_PIECES_AT_ZOOM

public static final String DRAW_PIECES_AT_ZOOM

See Also:

Constant Field Values

BORDER_WIDTH

public static final String BORDER_WIDTH

See Also:

Constant Field Values

SHOW_NOSTACK

public static final String SHOW_NOSTACK

See Also:

Constant Field Values

SHOW_MOVE_SELECTED

public static final String SHOW_MOVE_SELECTED

See Also:

Constant Field Values

SHOW_NON_MOVABLE

public static final String SHOW_NON_MOVABLE

See Also:

Constant Field Values

SHOW_DECK

public static final String SHOW_DECK

See Also:

Constant Field Values

SHOW_DECK_DEPTH

public static final String SHOW_DECK_DEPTH

See Also:

Constant Field Values

SHOW_OVERLAP

public static final String SHOW_OVERLAP

See Also:

Constant Field Values

UNROTATE_PIECES

public static final String UNROTATE_PIECES

See Also:

Constant Field Values

DISPLAY

public static final String DISPLAY

See Also:

Constant Field Values

LAYER_LIST

public static final String LAYER_LIST

See Also:

Constant Field Values

SUMMARY_REPORT_FORMAT

public static final String SUMMARY_REPORT_FORMAT

See Also:

Constant Field Values

COUNTER_REPORT_FORMAT

public static final String COUNTER_REPORT_FORMAT

See Also:

Constant Field Values

EMPTY_HEX_REPORT_FORMAT

public static final String EMPTY_HEX_REPORT_FORMAT

See Also:

Constant Field Values

VERSION

public static final String VERSION

See Also:

Constant Field Values

FG_COLOR

public static final String FG_COLOR

See Also:

Constant Field Values

BG_COLOR

public static final String BG_COLOR

See Also:

Constant Field Values

FONT_SIZE

public static final String FONT_SIZE

See Also:

Constant Field Values

EXTRA_TEXT_PADDING

public static final String EXTRA_TEXT_PADDING

See Also:

Constant Field Values

PROPERTY_FILTER

public static final String PROPERTY_FILTER

See Also:

Constant Field Values

TOP_LAYER

public static final String TOP_LAYER

See Also:

Constant Field Values

ALL_LAYERS

public static final String ALL_LAYERS

See Also:

Constant Field Values

INC_LAYERS

public static final String INC_LAYERS

See Also:

Constant Field Values

EXC_LAYERS

public static final String EXC_LAYERS

See Also:

Constant Field Values

FILTER

public static final String FILTER

See Also:

Constant Field Values

SUM

public static final String SUM

See Also:

Constant Field Values

hotkey

protected KeyStroke hotkey

map

protected Map map

delay

protected int delay

delayTimer

protected Timer delayTimer

graphicsVisible

protected boolean graphicsVisible

textVisible

protected boolean textVisible

currentMousePosition

protected MouseEvent currentMousePosition

desc

protected String desc

minimumDisplayablePieces

protected int minimumDisplayablePieces

alwaysShowLoc

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected boolean alwaysShowLoc

Deprecated, for removal: This API element is subject to removal in a future version.

drawPieces

protected boolean drawPieces

drawSingleDeprecated

protected boolean drawSingleDeprecated

showText

protected boolean showText

showTextSingleDeprecated

protected boolean showTextSingleDeprecated

enableHTML

protected boolean enableHTML

centerAll

protected boolean centerAll

centerText

protected boolean centerText

combineCounterSummary

protected boolean combineCounterSummary

verticalOffset

protected int verticalOffset

verticalTopText

protected int verticalTopText

stretchWidthSummary

protected boolean stretchWidthSummary

unrotatePieces

protected boolean unrotatePieces

showDeck

protected boolean showDeck

showDeckDepth

protected static int showDeckDepth

showOverlap

protected boolean showOverlap

zoomLevel

protected double zoomLevel

graphicsZoomLevel

protected double graphicsZoomLevel

borderWidth

protected int borderWidth

extraTextPadding

protected int extraTextPadding

showNoStack

protected boolean showNoStack

showMoveSelected

protected boolean showMoveSelected

showNonMovable

protected boolean showNonMovable

displayWhat

protected String displayWhat

displayLayers

protected String[] displayLayers

summaryReportFormat

protected FormattedString summaryReportFormat

counterReportFormat

protected FormattedString counterReportFormat

emptyHexReportFormat

protected FormattedString emptyHexReportFormat

version

protected String version

fgColor

protected Color fgColor

bgColor

protected Color bgColor

fontSize

protected int fontSize

font

protected Font font

propertyFilter

protected PropertyExpression propertyFilter

bounds

protected Rectangle bounds

lastPieceBounds

protected Rectangle lastPieceBounds

mouseInView

protected boolean mouseInView

displayablePieces

protected List<GamePiece> displayablePieces

view

protected JComponent view

the JComponent which is repainted when the detail viewer changes

Constructor Details

CounterDetailViewer

public CounterDetailViewer()

Method Details

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Parameters:

b - parent Buildable to add this component to as a subcomponent.

draw

public void draw(Graphics g,
 Map map)

Specified by:

draw in interface Drawable

drawAboveCounters

public boolean drawAboveCounters()

Specified by:

drawAboveCounters in interface Drawable

draw

public void draw(Graphics g,
 Point pt,
 JComponent comp)

drawGraphics

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void drawGraphics(Graphics g,
 Point pt,
 JComponent comp,
 PieceIterator pi)

Deprecated, for removal: This API element is subject to removal in a future version.

Use drawGraphics(Graphics, Point, JComponent, List)

drawGraphics

protected void drawGraphics(Graphics g,
 Point pt,
 JComponent comp,
 List<GamePiece> pieces)

fixBounds

protected void fixBounds(List<GamePiece> pieces)

Set the bounds field large enough to accommodate the given set of pieces

getBounds

protected Rectangle getBounds(GamePiece piece)

isTextUnderCounters

protected boolean isTextUnderCounters()

drawText

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void drawText(Graphics g,
 Point pt,
 JComponent comp,
 PieceIterator pi)

Deprecated, for removal: This API element is subject to removal in a future version.

Use drawText(Graphics, Point, JComponent, List)

drawText

protected void drawText(Graphics g,
 Point pt,
 JComponent comp,
 List<GamePiece> pieces)

Label with the location If the counter viewer is being displayed, then place the location name just above the left hand end of the counters. If no counter viewer (i.e. single piece or expanded stack), then place the location name above the centre of the first piece in the stack.

Parameters:

g - - graphics element

pt - - UNUSED IN THESE LATTER DAYS

comp - - UNUSED IN THESE LATTER DAYS

pieces - - UNUSED IN THESE LATTER DAYS

drawLabel

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void drawLabel(Graphics g,
 Point pt,
 String label)

Deprecated, for removal: This API element is subject to removal in a future version.

Use {drawLabel(Graphics, Point, String, int, int)}

drawLabel

protected void drawLabel(Graphics g,
 Point pt,
 String label,
 int hAlign,
 int vAlign)

drawLabel

protected void drawLabel(Graphics g,
 Point pt,
 String label,
 int hAlign,
 int vAlign,
 int objectWidth,
 int minWidth,
 int extraBorder,
 boolean skipBox)

Next, we go to this intermediate method, which deals with a couple of things (like deciding whether we're drawing in HTML mode or not) and then calls the LabelUtils to do the Hard Work.

Parameters:

g - our graphics object

pt - Point for drawing label, based on hAlign/Valign. (but if objectWidth > 0 then the "x" part identifies the left part of our master object)

label - Text we shall draw

hAlign - Horizontal alignment (left, right, center)

vAlign - Vertical alignment (top, bottom, center)

objectWidth - 0 for default, or optional width of master object we are to draw text label within

minWidth - 0 for default, or minimum width of text label

extraBorder - 0 for default, or number of extra pixels of border (expands size of label drawn)

skipBox - If true, ONLY draws the text, with no box or background (for filling in existing combine-o-rama boxes)

showDetails

protected void showDetails()

getZoom

protected double getZoom()

getDisplayablePieces

protected List<GamePiece> getDisplayablePieces()

Build an ArrayList of pieces to be displayed in order from bottom up, based on selection criteria setup in config.

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

getPreferredDelay

protected int getPreferredDelay()

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited 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

dragMouseMoved

public void dragMouseMoved(DragSourceDragEvent e)

Specified by:

dragMouseMoved in interface DragSourceMotionListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

hideDetails

protected void hideDetails()

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable

Returns:

Configurer for this component

upgrade

protected void upgrade()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for 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 interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

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()

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

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 Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

setAttribute

public void setAttribute(String name,
 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:

name - 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()

getAttributeValueString

public String getAttributeValueString(String name)

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:

name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getConfigureName

public String getConfigureName()

Description copied from class: AbstractConfigurable

ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.

Specified by:

getConfigureName in interface Configurable

Overrides:

getConfigureName in class AbstractConfigurable

Returns:

The language-independent name of this component used for programmatic identification (including within Modules by e.g. Traits and module components)

getConfigureTypeName

public static String getConfigureTypeName()

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.

getExpressionList

public List<String> getExpressionList()

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class AbstractConfigurable

Returns:

a list of the Configurables string/expression fields if any (for search)

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class AbstractConfigurable

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class AbstractConfigurable

Returns:

a list of any Named KeyStrokes referenced in the Configurable, if any (for search)

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

In case our labels refer to any image files

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractImageFinder

Parameters:

s - Collection to add image names to