com.actinarium.rhythm.layer

Class GridLines

java.lang.Object

com.actinarium.rhythm.layer.GridLines

All Implemented Interfaces:

RhythmSpecLayer

public class GridLines
extends java.lang.Object
implements RhythmSpecLayer

A spec layer for horizontal or vertical grid lines (not both at once!), repeating at a fixed step. Horizontal grid can float either to the top or the bottom edge of the views, whereas vertical grid can float to the left or the right. You can (and should) combine multiple grid line layers to form regular grids, or you may use them alone for baseline grids and incremental keylines. Note: RTL properties are not supported, you only have left and right at your disposal.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_GRID_COLOR
static int	DEFAULT_THICKNESS Default grid line thickness (1px)
protected int	mEdgeAffinity
protected int	mLimit
protected int	mOffset
protected android.graphics.Paint	mPaint
protected float	mStep
protected int	mThickness

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridLines() Create a spec layer that displays dimensions label.
	GridLines(int edgeAffinity, float step) Create a layer that draws horizontal or vertical grid lines.

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)
GridLines	setColor(int color) Set grid line color
GridLines	setEdgeAffinity(int edgeAffinity) Set edge affinity of the grid
GridLines	setLimit(int limit) Set the maximum number of steps to outline, respecting layer’s gravity (i.e.
GridLines	setOffset(int offset) Set additional grid offset.
GridLines	setStep(float step) Set the step of grid lines
GridLines	setThickness(int thickness) Set grid line thickness

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GRID_COLOR

public static final int DEFAULT_GRID_COLOR

See Also:

Constant Field Values

DEFAULT_THICKNESS

public static final int DEFAULT_THICKNESS

Default grid line thickness (1px)

See Also:

Constant Field Values

mStep

protected float mStep

mThickness

protected int mThickness

mLimit

protected int mLimit

mOffset

protected int mOffset

mEdgeAffinity

protected int mEdgeAffinity

mPaint

protected android.graphics.Paint mPaint

Constructor Detail

GridLines

public GridLines(int edgeAffinity,
                 float step)

Create a layer that draws horizontal or vertical grid lines. Unless offset is applied, horizontal lines are always drawn below the delimited pixel row, and vertical lines are always drawn to the right of the delimited column: e.g. if a child view is fully aligned to the grid on all edges, top and bottom grid lines will overdraw the view, whereas bottom and right grid lines will touch the view.

Parameters:

edgeAffinity - Controls grid alignment and orientation. Gravity.TOP and Gravity.BOTTOM mean horizontal lines, and Gravity.LEFT and Gravity.RIGHT mean vertical lines, and the difference between those is from what edge of the view the steps are counted. A good example where this can be useful is having a left-aligned and a right-aligned layer on the left and the right half of the view when its width is not an exact multiple of the step.

step - Grid step, in pixels. Allows for float values to properly accommodate devices with non-round dip-to-pixel ratio (1.5x on hdpi, 2.5x on Nexus 5X etc)

GridLines

protected GridLines()

Create a spec layer that displays dimensions label.

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

setStep

public GridLines setStep(float step)

Set the step of grid lines

Parameters:

step - Grid step, in pixels. Allows for float values to properly accommodate devices with non-round dip-to-pixel ratio (1.5x on hdpi, 2.5x on Nexus 5X etc)

Returns:

this for chaining

setEdgeAffinity

public GridLines setEdgeAffinity(int edgeAffinity)

Set edge affinity of the grid

Parameters:

edgeAffinity - Controls grid alignment and orientation. Use Gravity.TOP or Gravity.BOTTOM for horizontal lines counting from top or bottom, and Gravity.LEFT or Gravity.RIGHT for vertical lines cointing from left or right edge of the screen respectively.

Returns:

this for chaining

setColor

public GridLines setColor(int color)

Set grid line color

Parameters:

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

Returns:

this for chaining

setThickness

public GridLines setThickness(int thickness)

Set grid line thickness

Parameters:

thickness - Grid line thickness, in pixels

Returns:

this for chaining

setLimit

public GridLines setLimit(int limit)

Set the maximum number of steps to outline, respecting layer’s gravity (i.e. if gravity is set to Gravity.BOTTOM and the limit is 4, this layer will draw four lines enclosing 4 cells. Default is no limit.

Parameters:

limit - Number of lines to draw. Setting zero or less means no limit.

Returns:

this for chaining

setOffset

public GridLines setOffset(int offset)

Set additional grid offset. Might be useful if you need to tweak the position of the grid just a few pixels up or down, or prevent overdraw when combining a few interleaving grids (e.g. to add a 4dp baseline grid to a 8dp regular grid you only need to draw each second baseline, which is done with a 8dp step and a 4dp offset).

Parameters:

offset - Grid offset in pixels. Regardless of gravity, positive offset means right/down, negative means left/up

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.