com.actinarium.rhythm.layer

Class Inset

java.lang.Object

com.actinarium.rhythm.AbstractSpecLayerGroup<Inset>

com.actinarium.rhythm.layer.Inset

All Implemented Interfaces:

RhythmSpecLayer, RhythmSpecLayerParent

public class Inset
extends AbstractSpecLayerGroup<Inset>

A group that clips and/or insets its child layers. Allows setting left, right, top, and bottom insets, positive or negative, as well as width and height, all in either absolute dimensions or as percent of parent. Setting width or height takes precedence over setting insets in the following way: if width (height) and right (bottom) are set but left (top) is not, the block floats to the right (bottom), otherwise it stays on the left (top).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Inset.Factory A default factory that creates new Inset layers from config lines according to the docs
static interface	Inset.Mode Type definition for inset group type

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mBottom
protected int	mHeight
protected android.graphics.Rect	mInsetRect
protected boolean	mIsBottomPercent
protected boolean	mIsBottomSet
protected boolean	mIsHeightPercent
protected boolean	mIsHeightSet
protected boolean	mIsLeftPercent
protected boolean	mIsLeftSet
protected boolean	mIsRightPercent
protected boolean	mIsRightSet
protected boolean	mIsTopPercent
protected boolean	mIsTopSet
protected boolean	mIsWidthPercent
protected boolean	mIsWidthSet
protected int	mLeft
protected int	mMode
static int	MODE_CLIP_ONLY Clip the group according to inset rect but keep the coordinates.
static int	MODE_DEFAULT Inset the bounds and clip the overlay.
static int	MODE_NO_CLIP Inset the bounds but don't clip drawing to the overlay.
protected int	mRight
protected int	mTop
protected int	mWidth
static boolean	UNITS_PERCENT Dimension specified in percent of container
static boolean	UNITS_PX Dimension specified in pixels

Fields inherited from class com.actinarium.rhythm.AbstractSpecLayerGroup

ESTIMATED_AVG_LAYERS, mLayers

Constructor Summary

Constructors

Constructor and Description
Inset() Create a layer group that clips and/or insets its child layers
Inset(int initialCapacity) Create a layer group that clips and/or insets its child layers

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)
protected void	recalculateInsetRect(android.graphics.Rect outerBounds) Update the inset bounds based on provided outer bounds and this layer's state
Inset	setBottom(int value, boolean isPercent) Set bottom inset
Inset	setHeight(int value, boolean isPercent) Set height.
Inset	setLeft(int value, boolean isPercent) Set left inset
Inset	setMode(int mode) Set inset mode — whether the group should also clip the children, translate the coordinates, or both
Inset	setRight(int value, boolean isPercent) Set right inset
Inset	setTop(int value, boolean isPercent) Set top inset
Inset	setWidth(int value, boolean isPercent) Set width.

Methods inherited from class com.actinarium.rhythm.AbstractSpecLayerGroup

addLayer, size

Methods inherited from class java.lang.Object

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

Field Detail

MODE_DEFAULT

public static final int MODE_DEFAULT

Inset the bounds and clip the overlay. Default behavior

See Also:

Constant Field Values

MODE_NO_CLIP

public static final int MODE_NO_CLIP

Inset the bounds but don't clip drawing to the overlay. Best used for margins

See Also:

Constant Field Values

MODE_CLIP_ONLY

public static final int MODE_CLIP_ONLY

Clip the group according to inset rect but keep the coordinates. Best for clipping an absolutely positioned overlay

See Also:

Constant Field Values

UNITS_PX

public static final boolean UNITS_PX

Dimension specified in pixels

See Also:

Constant Field Values

UNITS_PERCENT

public static final boolean UNITS_PERCENT

Dimension specified in percent of container

See Also:

Constant Field Values

mMode

protected int mMode

mIsLeftPercent

protected boolean mIsLeftPercent

mIsTopPercent

protected boolean mIsTopPercent

mIsRightPercent

protected boolean mIsRightPercent

mIsBottomPercent

protected boolean mIsBottomPercent

mLeft

protected int mLeft

mTop

protected int mTop

mRight

protected int mRight

mBottom

protected int mBottom

mIsWidthPercent

protected boolean mIsWidthPercent

mIsHeightPercent

protected boolean mIsHeightPercent

mWidth

protected int mWidth

mHeight

protected int mHeight

mIsLeftSet

protected boolean mIsLeftSet

mIsRightSet

protected boolean mIsRightSet

mIsTopSet

protected boolean mIsTopSet

mIsBottomSet

protected boolean mIsBottomSet

mIsWidthSet

protected boolean mIsWidthSet

mIsHeightSet

protected boolean mIsHeightSet

mInsetRect

protected android.graphics.Rect mInsetRect

Constructor Detail

Inset

public Inset()

Create a layer group that clips and/or insets its child layers

Inset

public Inset(int initialCapacity)

Create a layer group that clips and/or insets its child layers

Parameters:

initialCapacity - anticipated number of child layers

Method Detail

setMode

public Inset setMode(int mode)

Set inset mode — whether the group should also clip the children, translate the coordinates, or both

Parameters:

mode - one of MODE_NO_CLIP, MODE_CLIP_ONLY, or MODE_DEFAULT

Returns:

this for chaining

See Also:

MODE_DEFAULT, MODE_NO_CLIP, MODE_CLIP_ONLY

setTop

public Inset setTop(int value,
                    boolean isPercent)

Set top inset

Parameters:

value - pixels or percent

isPercent - true if value is in percent, false if in pixels

Returns:

this for chaining

setBottom

public Inset setBottom(int value,
                       boolean isPercent)

Set bottom inset

Parameters:

value - pixels or percent

isPercent - true if value is in percent, false if in pixels

Returns:

this for chaining

setLeft

public Inset setLeft(int value,
                     boolean isPercent)

Set left inset

Parameters:

value - pixels or percent

isPercent - true if value is in percent, false if in pixels

Returns:

this for chaining

setRight

public Inset setRight(int value,
                      boolean isPercent)

Set right inset

Parameters:

value - pixels or percent

isPercent - true if value is in percent, false if in pixels

Returns:

this for chaining

setWidth

public Inset setWidth(int value,
                      boolean isPercent)

Set width. If both width, left inset, and right inset are set, right inset is ignored

Parameters:

value - pixels or percent

isPercent - true if value is in percent, false if in pixels

Returns:

this for chaining

setHeight

public Inset setHeight(int value,
                       boolean isPercent)

Set height. If both height, top inset, and bottom inset are set, bottom inset is ignored

Parameters:

value - pixels or percent

isPercent - true if value is in percent, false if in pixels

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

Overrides:

draw in class AbstractSpecLayerGroup<Inset>

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.

recalculateInsetRect

protected void recalculateInsetRect(android.graphics.Rect outerBounds)

Update the inset bounds based on provided outer bounds and this layer's state

Parameters:

outerBounds - Outer bounds provided to this inset layer to modify