com.actinarium.rhythm.layer

Class Keyline

java.lang.Object

com.actinarium.rhythm.layer.Keyline

All Implemented Interfaces:

RhythmSpecLayer

public class Keyline
extends java.lang.Object
implements RhythmSpecLayer

A layer that draws a horizontal or vertical full-bleed keyline at the specified distance from the specified edge of a view. Can be used to draw “thin” keylines, as well as thick highlights (e.g. margins in avatar list view), although it's recommended to use Fill inside an Inset for the latter. The keyline is drawn towards the specified edge by default (i.e. touching aligned child views), but this can be tweaked using setAlignOutside(boolean) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Keyline.Factory A default factory that creates new Keyline layers from config lines according to the docs

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ALIGN_INSIDE
static boolean	ALIGN_OUTSIDE
static int	DEFAULT_KEYLINE_COLOR
static int	DEFAULT_THICKNESS Default keyline thickness (2px)
protected boolean	mAlignOutside
protected int	mDistance
protected int	mEdgeAffinity
protected android.graphics.Paint	mPaint
protected int	mThickness

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Keyline() Create a layer that draws a horizontal or vertical keyline at a specified distance from required edge.
	Keyline(int edgeAffinity, int distance) Create a layer that draws a horizontal or vertical keyline at a specified distance from required edge

Method Summary

Modifier and Type	Method and Description
void	draw(android.graphics.Canvas canvas, android.graphics.Rect drawableBounds) Draw itself to the provided canvas within provided bounds according to internal configuration (if any)
Keyline	setAlignOutside(boolean alignOutside) Set keyline alignment.
Keyline	setColor(int color) Set keyline color
Keyline	setDistance(int distance) Set the distance of the keyline from specified edge
Keyline	setEdgeAffinity(int edgeAffinity) Set edge affinity of the keyline
Keyline	setThickness(int thickness) Set keyline thickness

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEYLINE_COLOR

public static final int DEFAULT_KEYLINE_COLOR

See Also:

Constant Field Values

DEFAULT_THICKNESS

public static final int DEFAULT_THICKNESS

Default keyline thickness (2px)

See Also:

Constant Field Values

ALIGN_INSIDE

public static final boolean ALIGN_INSIDE

See Also:

Constant Field Values

ALIGN_OUTSIDE

public static final boolean ALIGN_OUTSIDE

See Also:

Constant Field Values

mEdgeAffinity

protected int mEdgeAffinity

mDistance

protected int mDistance

mThickness

protected int mThickness

mAlignOutside

protected boolean mAlignOutside

mPaint

protected android.graphics.Paint mPaint

Constructor Detail

Keyline

public Keyline(int edgeAffinity,
               int distance)

Create a layer that draws a horizontal or vertical keyline at a specified distance from required edge

Parameters:

edgeAffinity - Defines the edge of the view this keyline must be anchored to. Values (Gravity.LEFT and Gravity.RIGHT) will result in a vertical keyline, and values (Gravity.TOP and Gravity.BOTTOM) will result in a horizontal keyline.

distance - Distance of this keyline from the specified edge, in pixels

See Also:

setAlignOutside(boolean)

Keyline

protected Keyline()

Create a layer that draws a horizontal or vertical keyline at a specified distance from required edge.

This is a minimum constructor for the factory — only paints and reusable objects are initialized. Developers extending this class are responsible for setting all fields to proper argument values.

Method Detail

setDistance

public Keyline setDistance(int distance)

Set the distance of the keyline from specified edge

Parameters:

distance - Distance of this keyline from the specified edge, in pixels

Returns:

this for chaining

setEdgeAffinity

public Keyline setEdgeAffinity(int edgeAffinity)

Set edge affinity of the keyline

Parameters:

edgeAffinity - Defines the edge of the view this keyline must be anchored to. Values (Gravity.LEFT and Gravity.RIGHT) will result in a vertical keyline, and values (Gravity.TOP and Gravity.BOTTOM) will result in a horizontal keyline.

Returns:

this for chaining

setColor

public Keyline setColor(int color)

Set keyline color

Parameters:

color - Grid line color, in #AARRGGBB format as usual

Returns:

this for chaining

setThickness

public Keyline setThickness(int thickness)

Set keyline thickness

Parameters:

thickness - Keyline thickness, in pixels. For keylines keep thickness around a few pixels, whereas for highlights feel free to use as many dips as required.

Returns:

this for chaining

See Also:

setAlignOutside(boolean)

setAlignOutside

public Keyline setAlignOutside(boolean alignOutside)

Set keyline alignment. By default, the keyline is drawn towards the specified edge, i.e. if edge affinity is BOTTOM, distance is 24px and thickness is 6px, the keyline will appear as a horizontal rectangle starting at the 18th and ending at the 23rd pixel row from the bottom. You can use this method to override that behavior and make the keyline face outwards (24th to 29th pixel rows in aforementioned example).

Parameters:

alignOutside - either false (ALIGN_INSIDE, default) for the keyline to extend towards the edge defined by edge affinity, or true (ALIGN_OUTSIDE) to extend away from the edge

Returns:

this for chaining

draw

public void draw(android.graphics.Canvas canvas,
                 android.graphics.Rect drawableBounds)

Description copied from interface: RhythmSpecLayer

Draw itself to the provided canvas within provided bounds according to internal configuration (if any)

Specified by:

draw in interface RhythmSpecLayer

Parameters:

canvas - Canvas for the layer to draw itself to

drawableBounds - Bounds where this layer should draw itself. Since these are the bounds of a RhythmDrawable connected to the view, they are usually the same as the view’s bounds, so you can use this parameter to get the view’s dimensions should you need them.