com.actinarium.rhythm

Class RhythmOverlay

java.lang.Object

com.actinarium.rhythm.AbstractSpecLayerGroup<RhythmOverlay>

com.actinarium.rhythm.RhythmOverlay

All Implemented Interfaces:

RhythmSpecLayer, RhythmSpecLayerParent

public class RhythmOverlay
extends AbstractSpecLayerGroup<RhythmOverlay>

Defines a single overlay configuration, i.e. which spec layers (grid lines, keylines etc) must be drawn in the RhythmDrawable(s) where this overlay is currently set. Composed of granular RhythmSpecLayers, which hold their own configuration (see descriptions of respectable implementations) and are drawn in the order of adding.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mTitle

Fields inherited from class com.actinarium.rhythm.AbstractSpecLayerGroup

ESTIMATED_AVG_LAYERS, mLayers

Constructor Summary

Constructors

Constructor and Description
RhythmOverlay() Create a new overlay
RhythmOverlay(int initialCapacity) Create a new overlay with initial capacity

Method Summary

Modifier and Type	Method and Description
RhythmOverlay	addLayersFrom(RhythmOverlay source) Add all layers to this overlay from another.
java.lang.String	getTitle() Get overlay title
RhythmOverlay	setTitle(java.lang.String title) Set the title for this overlay.
java.lang.String	toString()

Methods inherited from class com.actinarium.rhythm.AbstractSpecLayerGroup

addLayer, draw, size

Methods inherited from class java.lang.Object

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

Field Detail

mTitle

protected java.lang.String mTitle

Constructor Detail

RhythmOverlay

public RhythmOverlay()

Create a new overlay

RhythmOverlay

public RhythmOverlay(int initialCapacity)

Create a new overlay with initial capacity

Parameters:

initialCapacity - anticipated number of child layers

Method Detail

setTitle

public RhythmOverlay setTitle(java.lang.String title)

Set the title for this overlay. The title is only displayed in Rhythm control notification — you don't need it in programmatically created anonymous overlays.

Parameters:

title - A convenient title for this overlay.

Returns:

this for chaining

getTitle

public java.lang.String getTitle()

Get overlay title

Returns:

overlay title of null if the overlay is anonymous

addLayersFrom

public RhythmOverlay addLayersFrom(@NonNull
                                   RhythmOverlay source)

Add all layers to this overlay from another. Convenient if you have a common set of layers that you wish to include in multiple overlays, or want to create an overlay that combines a few others.

Warning: for simplicity and performance reasons the same layer objects are used, therefore it’s strongly advised that you don’t mutate them after adding.

Parameters:

source - Existing overlay to add all layers from

Returns:

this for chaining

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object