com.actinarium.rhythm.layer

Class RatioKeyline

java.lang.Object

com.actinarium.rhythm.layer.RatioKeyline

All Implemented Interfaces:

RhythmSpecLayer

public class RatioKeyline
extends java.lang.Object
implements RhythmSpecLayer

A single horizontal keyline whose distance from the top is calculated from the width of current bounds and given aspect ratio. Displays the label in the bottom right corner of the enclosed rectangle. Experimental at the moment, meaning its behavior, appearance, and parameters may change. As of now, the keyline label is always 12dp high, 24dp wide, has 10dp font that shrinks if not fitting, and is always within the enclosed rectangle, i.e. overdrawing its bottom edge.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FILL_COLOR
protected static int	DEFAULT_LABEL_HEIGHT
static int	DEFAULT_TEXT_COLOR
static int	DEFAULT_TEXT_SIZE
static int	DEFAULT_THICKNESS
protected android.graphics.Paint	mBackgroundPaint
protected int	mLabelHeight
protected android.graphics.Path	mLabelPath
protected int	mLabelRectWidth
protected int	mLabelSideWidth
protected int	mRatioX
protected int	mRatioY
protected android.graphics.Rect	mTempRect
protected java.lang.String	mText
protected android.text.TextPaint	mTextPaint
protected int	mThickness

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RatioKeyline(android.util.DisplayMetrics metrics)
	RatioKeyline(int ratioX, int ratioY, android.util.DisplayMetrics metrics)

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)
RatioKeyline	setKeylineColor(int color) Set the color of ratio keyline and label background
RatioKeyline	setRatio(int ratioX, int ratioY) Set ratio of the box this keyline should define, in form of two terms
RatioKeyline	setText(java.lang.String text) Set arbitrary label text to this ratio keyline.
RatioKeyline	setTextColor(int color) Set ratio keyline label text color
RatioKeyline	setThickness(int thickness) Set ratio keyline thickness

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILL_COLOR

public static final int DEFAULT_FILL_COLOR

See Also:

Constant Field Values

DEFAULT_TEXT_COLOR

public static final int DEFAULT_TEXT_COLOR

See Also:

Constant Field Values

DEFAULT_THICKNESS

public static final int DEFAULT_THICKNESS

See Also:

Constant Field Values

DEFAULT_TEXT_SIZE

public static final int DEFAULT_TEXT_SIZE

See Also:

Constant Field Values

DEFAULT_LABEL_HEIGHT

protected static final int DEFAULT_LABEL_HEIGHT

See Also:

Constant Field Values

mRatioX

protected int mRatioX

mRatioY

protected int mRatioY

mThickness

protected int mThickness

mText

protected java.lang.String mText

mBackgroundPaint

protected android.graphics.Paint mBackgroundPaint

mTextPaint

protected android.text.TextPaint mTextPaint

mTempRect

protected android.graphics.Rect mTempRect

mLabelPath

protected android.graphics.Path mLabelPath

mLabelRectWidth

protected int mLabelRectWidth

mLabelHeight

protected int mLabelHeight

mLabelSideWidth

protected int mLabelSideWidth

Constructor Detail

RatioKeyline

public RatioKeyline(int ratioX,
                    int ratioY,
                    android.util.DisplayMetrics metrics)

RatioKeyline

protected RatioKeyline(android.util.DisplayMetrics metrics)

Method Detail

setRatio

public RatioKeyline setRatio(int ratioX,
                             int ratioY)

Set ratio of the box this keyline should define, in form of two terms

Parameters:

ratioX - antecedent, horizontal component of the ratio (e.g. 16 in 16:9)

ratioY - consequent, vertical component of the ratio (e.g. 9 in 16:9)

Returns:

this for chaining

setText

public RatioKeyline setText(@Nullable
                            java.lang.String text)

Set arbitrary label text to this ratio keyline. Defaults to displaying ratio.

Parameters:

text - Text to display in keyline label. Set null to reset the label to display ratio.

Returns:

this for chaining

setThickness

public RatioKeyline setThickness(int thickness)

Set ratio keyline thickness

Parameters:

thickness - Ratio keyline thickness, in pixels. At the moment, ratio keyline will be drawn within enclosed bounds, so that regardless of thickness it doesn't cover pixels not within ratio box.

Returns:

this for chaining

setKeylineColor

public RatioKeyline setKeylineColor(int color)

Set the color of ratio keyline and label background

Parameters:

color - Ratio keyline color, in #AARRGGBB format as usual

Returns:

this for chaining

setTextColor

public RatioKeyline setTextColor(int color)

Set ratio keyline label text color

Parameters:

color - Label text color, in #AARRGGBB format as usual

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.