Package ca.cgjennings.apps.arkham.deck.item

Class OutlinedTile

java.lang.Object

ca.cgjennings.apps.arkham.deck.item.AbstractItem

ca.cgjennings.apps.arkham.deck.item.AbstractFlippableItem

ca.cgjennings.apps.arkham.deck.item.AbstractRenderedItem

ca.cgjennings.apps.arkham.deck.item.Tile

ca.cgjennings.apps.arkham.deck.item.OutlinedTile

All Implemented Interfaces:

FlippablePageItem, PageItem, java.io.Serializable, java.lang.Cloneable

public class OutlinedTile
extends Tile

A tile with a static outline. This class is used to instantiate tile set entries for tiles with outlines. It provides methods similar to OutlineStyle, but it does not actually implement that interface, so the outline cannot be configured through the StyleEditor.

Since:

3.0

Author:

Chris Jennings

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ca.cgjennings.apps.arkham.deck.item.PageItem

PageItem.SnapClass, PageItem.SnapTarget

Field Summary

Fields inherited from class ca.cgjennings.apps.arkham.deck.item.Tile

identifier

Fields inherited from class ca.cgjennings.apps.arkham.deck.item.AbstractRenderedItem

render

Fields inherited from class ca.cgjennings.apps.arkham.deck.item.AbstractFlippableItem

orientation

Fields inherited from class ca.cgjennings.apps.arkham.deck.item.AbstractItem

dragHandles, group, parent, selectionLock, snapClass, snapTarget, snapToClasses, xOff, yOff

Fields inherited from interface ca.cgjennings.apps.arkham.deck.item.PageItem

ICON_SIZE, ORIENT_MIRROR_TURN_LEFT, ORIENT_MIRROR_TURN_RIGHT, ORIENT_MIRROR_UPRIGHT, ORIENT_MIRROR_UPSIDEDOWN, ORIENT_TURN_LEFT, ORIENT_TURN_RIGHT, ORIENT_UPRIGHT, ORIENT_UPSIDEDOWN

Constructor Summary

Constructors

Constructor	Description
OutlinedTile(java.lang.String name, java.lang.String identifier, double ppi)	Creates a new outlined tile.

Method Summary

Modifier and Type	Method	Description
LineCap	getOutlineCap()	Returns the line cap style used on outline ends.
java.awt.Color	getOutlineColor()	Returns the color used to draw the outline.
DashPattern	getOutlineDashPattern()	Returns the dash pattern used to draw the outline.
LineJoin	getOutlineJoin()	Returns the method used to join the line segments that make up the outline.
float	getOutlineWidth()	Returns the width, in points, of the outline.
void	paint(java.awt.Graphics2D g, RenderTarget target, double renderResolutionHint)	Paint this item at its current location.
void	setOutlineCap(LineCap cap)	Sets the line cap style used on outline ends.
void	setOutlineColor(java.awt.Color borderColor)	Sets the color used to draw the outline.
void	setOutlineDashPattern(DashPattern pat)	Sets the dash pattern used to draw the outline.
void	setOutlineJoin(LineJoin borderJoin)	Sets the method used to join the line segments that make up the outline.
void	setOutlineWidth(float borderWidth)	Sets the color used to draw the outline.

Methods inherited from class ca.cgjennings.apps.arkham.deck.item.Tile

clearCachedImages, getDPI, getIdentifier, getImageFromIdentifier, getName, getResolution, getUprightHeight, getUprightWidth, isFastOutlineAllowed, isMipMapCacheEnabledByDefault, readImpl, renderImage, scaleMipMapUpAtHighZoom, setDPI, setFastOutlineAllowed, setIdentifier, setName, setOrientation, setResolution, writeImpl

Methods inherited from class ca.cgjennings.apps.arkham.deck.item.AbstractRenderedItem

clearCachedIcon, clone, createOrientedImage, getHeight, getOrientedImage, getThumbnailIcon, getWidth, isMipMapCacheEnabled, prepareToPaint, setMipMapCacheEnabled

Methods inherited from class ca.cgjennings.apps.arkham.deck.item.AbstractFlippableItem

flip, getOrientation, turnLeft, turnRight

Methods inherited from class ca.cgjennings.apps.arkham.deck.item.AbstractItem

customizePopupMenu, getBleedMargin, getClassesSnappedTo, getClientProperty, getDragHandles, getFoldMarks, getGroup, getLocation, getOutline, getPage, getRectangle, getSnapClass, getSnapTarget, getX, getY, hasExteriorHandles, hitTest, isBleedMarginMarked, isHorizontal, isMirrored, isSelectionLocked, isTurned0DegreesFrom, isTurned180DegreesFrom, isTurned90DegreesFrom, isVertical, itemChanged, itemChanging, putClientProperty, setClassesSnappedTo, setGroup, setLocation, setLocation, setPage, setSelectionLocked, setSnapClass, setSnapTarget, setX, setY, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.cgjennings.apps.arkham.deck.item.PageItem

customizePopupMenu, getBleedMargin, getClassesSnappedTo, getClientProperty, getDragHandles, getFoldMarks, getGroup, getLocation, getOutline, getPage, getRectangle, getSnapClass, getSnapTarget, getX, getY, hasExteriorHandles, hitTest, isBleedMarginMarked, isHorizontal, isMirrored, isSelectionLocked, isTurned0DegreesFrom, isTurned180DegreesFrom, isTurned90DegreesFrom, isVertical, putClientProperty, setClassesSnappedTo, setGroup, setLocation, setLocation, setPage, setSelectionLocked, setSnapClass, setSnapTarget, setX, setY

Constructor Detail

OutlinedTile

public OutlinedTile(java.lang.String name,
                    java.lang.String identifier,
                    double ppi)

Creates a new outlined tile.

Parameters:

name - the user-friendly tile name

identifier - the identifier used to determine the image to display

ppi - the tile image resolution, in pixels per inch

Method Detail

getOutlineColor

public java.awt.Color getOutlineColor()

Returns the color used to draw the outline.

Returns:

the outline color

setOutlineColor

public void setOutlineColor(java.awt.Color borderColor)

Sets the color used to draw the outline.

Parameters:

borderColor - the outline color

getOutlineWidth

public float getOutlineWidth()

Returns the width, in points, of the outline.

Returns:

the outline line width

setOutlineWidth

public void setOutlineWidth(float borderWidth)

Sets the color used to draw the outline.

getOutlineDashPattern

public DashPattern getOutlineDashPattern()

Returns the dash pattern used to draw the outline.

Returns:

the dash pattern for the outline

setOutlineDashPattern

public void setOutlineDashPattern(DashPattern pat)

Sets the dash pattern used to draw the outline.

Parameters:

pat - the dash pattern type

getOutlineJoin

public LineJoin getOutlineJoin()

Returns the method used to join the line segments that make up the outline.

Returns:

the line joining method

setOutlineJoin

public void setOutlineJoin(LineJoin borderJoin)

Sets the method used to join the line segments that make up the outline.

setOutlineCap

public void setOutlineCap(LineCap cap)

Sets the line cap style used on outline ends.

Parameters:

cap - the line cap type

getOutlineCap

public LineCap getOutlineCap()

Returns the line cap style used on outline ends.

Returns:

the line cap style

paint

public void paint(java.awt.Graphics2D g,
                  RenderTarget target,
                  double renderResolutionHint)

Description copied from interface: PageItem

Paint this item at its current location. The graphics context will be scaled so that 1 unit represents 1 point. The resolution hint is a suggestion as to the resolution the item should be rendered at if it must be converted to a bitmap before being drawn. It may or may not represent the actual resolution of the output target.

Specified by:

paint in interface PageItem

Overrides:

paint in class Tile

Parameters:

g - the graphics context to paint to

target - the type of destination being drawn to

renderResolutionHint - a source resolution hint