- getArgumentsBundle() - Method in class com.actinarium.rhythm.RhythmOverlayInflater.LayerConfig
-
- getBoolean(String, boolean) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get boolean argument.
- getBoolean(String, boolean) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
- getColor(String, int) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get argument value as color integer with fallback to default value if argument is missing.
- getColor(String, int) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
- getDecorated() - Method in class com.actinarium.rhythm.RhythmDrawable
-
Get decorated drawable (the one drawn under the overlay) if present
- getDimensionPixelExact(String, float) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
- getDimensionPixelExact(String, float) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
- getDimensionPixelOffset(String, int) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
- getDimensionPixelOffset(String, int) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
- getDimensionPixelRaw(float, int, DisplayMetrics) - Static method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Convert complex dimension value of provided units into pixels.
- getDimensionPixelSize(String, int) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
- getDimensionPixelSize(String, int) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get dimension argument value as pixels with possible fallback to default value if argument is missing or invalid.
- getDimensionUnits(String) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get the units of a dimension argument.
- getDimensionUnits(String) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get the units of a dimension argument.
- getDimensionValue(String, float) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get raw numeric value from dimension argument disregarding units and NOT performing any conversion to pixels.
- getDimensionValue(String, float) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get raw numeric value from dimension argument disregarding units and NOT performing any conversion to pixels.
- getDisplayMetrics() - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get display metrics associated with this arguments bundle.
- getDisplayMetrics() - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get display metrics associated with this arguments bundle.
- getEdgeAffinity(String, int) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get argument as an
ArgumentsBundle.EdgeAffinity
constant, which can be either
Gravity.TOP
,
Gravity.LEFT
,
Gravity.RIGHT
, or
Gravity.BOTTOM
, with fallback to default value if argument is missing or
invalid.
- getEdgeAffinity(String, int) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
- getFloat(String, float) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get argument value as float with fallback to default value if argument is missing.
- getFloat(String, float) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.layer.Columns.Factory
-
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.layer.DimensionsLabel.Factory
-
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.layer.Fill.Factory
-
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.layer.GridLines.Factory
-
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.layer.Inset.Factory
-
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.layer.Keyline.Factory
-
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.layer.RatioKeyline.Factory
-
- getForArguments(ArgumentsBundle) - Method in interface com.actinarium.rhythm.RhythmSpecLayerFactory
-
Create and configure a spec layer from provided arguments, or get previously created one from cache if it can be
safely reused.
- getForArguments(ArgumentsBundle) - Method in class com.actinarium.rhythm.SimpleCacheFactory
-
Returns layer for this configuration from cache, or creates a new one via decorated factory if not found in
cache
- getGravity(String, int) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get argument value as a gravity value (a combination of Gravity
constants) with fallback to default value
if argument is missing.
- getGravity(String, int) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get argument value as a gravity value (a combination of Gravity
constants) with fallback to default value
if argument is missing.
- getIndent() - Method in class com.actinarium.rhythm.RhythmOverlayInflater.LayerConfig
-
Get the number of spaces this config line was indented with.
- getInt(String, int) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get argument value as integer with fallback to default value if argument is missing.
- getInt(String, int) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
- getLayerType() - Method in class com.actinarium.rhythm.RhythmOverlayInflater.LayerConfig
-
Get the name of
spec layer
to inflate with these arguments
- getMessage() - Method in exception com.actinarium.rhythm.RhythmInflationException
-
- getOpacity() - Method in class com.actinarium.rhythm.RhythmDrawable
-
- getOverlay() - Method in class com.actinarium.rhythm.RhythmDrawable
-
Get current overlay
- getPadding(Rect) - Method in class com.actinarium.rhythm.RhythmDrawable
-
- getState() - Method in class com.actinarium.rhythm.RhythmDrawable
-
- getString(String) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get argument value as a string.
- getString(String, String) - Method in interface com.actinarium.rhythm.ArgumentsBundle
-
Get argument value as a string with fallback to default value if argument is missing.
- getString(String) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get argument value as a string.
- getString(String, String) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Get argument value as a string with fallback to default value if argument is missing.
- getTitle() - Method in class com.actinarium.rhythm.RhythmOverlay
-
Get overlay title
- GridLines - Class in com.actinarium.rhythm.layer
-
A spec layer for horizontal or vertical grid lines (not both at once!), repeating at a fixed step.
- GridLines(int, float) - Constructor for class com.actinarium.rhythm.layer.GridLines
-
Create a layer that draws horizontal or vertical grid lines.
- GridLines() - Constructor for class com.actinarium.rhythm.layer.GridLines
-
Create a spec layer that displays dimensions label.
- GridLines.Factory - Class in com.actinarium.rhythm.layer
-
A default factory that creates new
GridLines
layers from config lines according to
the docs
- inflate(int) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Inflate a Rhythm configuration file into a list of
RhythmOverlays
, which you can then
assign to a group, or make sub-lists of and assign to different groups.
- inflate(String) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
- inflate(List<String>) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
- inflateLayer(String, Map<String, String>) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Inflate an individual layer from raw configuration string and optional variables
- inflateLayerInternal(RhythmOverlayInflater.LayerConfig, int) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Inflate an individual layer from already parsed layer configuration.
- inflateOverlay(String) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Inflate a single overlay from overlay configuration string according to the syntax spec.
- inflateOverlay(String, Map<String, String>) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Inflate a single overlay from overlay configuration string according to the syntax spec.
- inflateOverlay(List<String>) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Inflate a single overlay from overlay configuration already presented as separate lines.
- inflateOverlay(List<String>, Map<String, String>) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Inflate a single overlay from overlay configuration already presented as separate lines.
- inflateOverlayInternal(List<String>, Map<String, String>, int) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Internal method for inflating an overlay from separate config lines, with provided global variables map, and
possibly as a part of an overlay config file.
- Inset - Class in com.actinarium.rhythm.layer
-
A group that clips and/or insets its child layers.
- Inset() - Constructor for class com.actinarium.rhythm.layer.Inset
-
Create a layer group that clips and/or insets its child layers
- Inset(int) - Constructor for class com.actinarium.rhythm.layer.Inset
-
Create a layer group that clips and/or insets its child layers
- Inset.Factory - Class in com.actinarium.rhythm.layer
-
A default factory that creates new
Inset
layers from config lines according to
the docs
- Inset.Mode - Annotation Type in com.actinarium.rhythm.layer
-
Type definition for inset group type
- isEmptyOrComment(String) - Static method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Utility method that determines whether the line is empty or a comment one (starts with //
) and thus
should be ignored.
- isStateful() - Method in class com.actinarium.rhythm.RhythmDrawable
-
- RatioKeyline - Class in com.actinarium.rhythm.layer
-
A single horizontal keyline whose distance from the top is calculated from the width of current bounds and given
aspect ratio.
- RatioKeyline(int, int, DisplayMetrics) - Constructor for class com.actinarium.rhythm.layer.RatioKeyline
-
- RatioKeyline(DisplayMetrics) - Constructor for class com.actinarium.rhythm.layer.RatioKeyline
-
- RatioKeyline.Factory - Class in com.actinarium.rhythm.layer
-
- ReaderUtils - Class in com.actinarium.rhythm.internal
-
Utility class that contains methods for reading data from input streams and raw resources
- readLines(InputStream) - Static method in class com.actinarium.rhythm.internal.ReaderUtils
-
Reads lines from input stream.
- readLines(Context, int) - Static method in class com.actinarium.rhythm.internal.ReaderUtils
-
Reads lines from given raw resource.
- recalculateInsetRect(Rect) - Method in class com.actinarium.rhythm.layer.Inset
-
Update the inset bounds based on provided outer bounds and this layer's state
- registerFactory(String, RhythmSpecLayerFactory) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Register a factory for provided layer type.
- resolveArgument(String) - Method in class com.actinarium.rhythm.MagicVariablesArgumentsBundle
-
Resolves argument value from the bundle.
- resolveArgument(String) - Method in class com.actinarium.rhythm.SimpleArgumentsBundle
-
Resolves argument value from the bundle.
- resolveVariableInternal(Map<String, String>, String, int) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Resolve variable value: if it's a reference to another variable (i.e.
- RhythmDrawable - Class in com.actinarium.rhythm
-
Renders the currently assigned
RhythmOverlay
and serves as an adapter between Rhythm (which sets the
overlay to draw by this drawable at the moment) and the views where the overlay (grids, keylines etc) must be
applied.
- RhythmDrawable(RhythmOverlay) - Constructor for class com.actinarium.rhythm.RhythmDrawable
-
Create a Rhythm drawable for given Rhythm overlay.
- RhythmInflationException - Exception in com.actinarium.rhythm
-
A runtime exception to be thrown when there is an error inflating declarative configuration, usually because of
syntax error or violated argument value constraints.
- RhythmInflationException() - Constructor for exception com.actinarium.rhythm.RhythmInflationException
-
- RhythmInflationException(String) - Constructor for exception com.actinarium.rhythm.RhythmInflationException
-
- RhythmInflationException(String, Throwable) - Constructor for exception com.actinarium.rhythm.RhythmInflationException
-
- RhythmInflationException(Throwable) - Constructor for exception com.actinarium.rhythm.RhythmInflationException
-
- RhythmOverlay - Class in com.actinarium.rhythm
-
Defines a single overlay configuration, i.e.
- RhythmOverlay() - Constructor for class com.actinarium.rhythm.RhythmOverlay
-
Create a new overlay
- RhythmOverlay(int) - Constructor for class com.actinarium.rhythm.RhythmOverlay
-
Create a new overlay with initial capacity
- RhythmOverlayInflater - Class in com.actinarium.rhythm
-
A default inflater that creates
RhythmOverlays from text configuration using registered layer
factories.
- RhythmOverlayInflater(Context) - Constructor for class com.actinarium.rhythm.RhythmOverlayInflater
-
Create a new instance of overlay inflater with no factories registered.
- RhythmOverlayInflater.LayerConfig - Class in com.actinarium.rhythm
-
A spec layer descriptor holding arguments and metadata, used internally by
RhythmOverlayInflater
to carry
values needed to inflate individual layers and their hierarchies.
- RhythmSpecLayer - Interface in com.actinarium.rhythm
-
Spec layer is a descriptor of a granular piece of overlay (e.g.
- RhythmSpecLayerFactory<T extends RhythmSpecLayer> - Interface in com.actinarium.rhythm
-
- RhythmSpecLayerParent - Interface in com.actinarium.rhythm
-
An object that can contain other spec layers.
- RuntimeIOException - Exception in com.actinarium.rhythm.internal
-
A runtime counterpart of IOException
thrown when the library cannot operate on provided data stream.
- RuntimeIOException() - Constructor for exception com.actinarium.rhythm.internal.RuntimeIOException
-
- RuntimeIOException(String) - Constructor for exception com.actinarium.rhythm.internal.RuntimeIOException
-
- RuntimeIOException(Throwable) - Constructor for exception com.actinarium.rhythm.internal.RuntimeIOException
-
- RuntimeIOException(String, Throwable) - Constructor for exception com.actinarium.rhythm.internal.RuntimeIOException
-
- setAlignOutside(boolean) - Method in class com.actinarium.rhythm.layer.Keyline
-
Set keyline alignment.
- setAlpha(int) - Method in class com.actinarium.rhythm.RhythmDrawable
-
- setBackgroundColor(int) - Method in class com.actinarium.rhythm.layer.DimensionsLabel
-
Set label background color
- setBottom(int, boolean) - Method in class com.actinarium.rhythm.layer.Inset
-
Set bottom inset
- setColor(int) - Method in class com.actinarium.rhythm.layer.Fill
-
Set fill color
- setColor(int) - Method in class com.actinarium.rhythm.layer.GridLines
-
Set grid line color
- setColor(int) - Method in class com.actinarium.rhythm.layer.Keyline
-
Set keyline color
- setColorFilter(ColorFilter) - Method in class com.actinarium.rhythm.RhythmDrawable
-
- setColumnCount(int) - Method in class com.actinarium.rhythm.layer.Columns
-
Set the number of columns
- setDecorated(Drawable) - Method in class com.actinarium.rhythm.RhythmDrawable
-
Set a Drawable
to decorate.
- setDistance(int) - Method in class com.actinarium.rhythm.layer.Keyline
-
Set the distance of the keyline from specified edge
- setEdgeAffinity(int) - Method in class com.actinarium.rhythm.layer.GridLines
-
Set edge affinity of the grid
- setEdgeAffinity(int) - Method in class com.actinarium.rhythm.layer.Keyline
-
Set edge affinity of the keyline
- setGravity(int) - Method in class com.actinarium.rhythm.layer.DimensionsLabel
-
Set label gravity.
- setHeight(int, boolean) - Method in class com.actinarium.rhythm.layer.Inset
-
Set height.
- setKeylineColor(int) - Method in class com.actinarium.rhythm.layer.RatioKeyline
-
Set the color of ratio keyline and label background
- setLeft(int, boolean) - Method in class com.actinarium.rhythm.layer.Inset
-
Set left inset
- setLimit(int) - Method in class com.actinarium.rhythm.layer.GridLines
-
Set the maximum number of steps to outline, respecting layer’s gravity (i.e.
- setLineNumber(int) - Method in exception com.actinarium.rhythm.RhythmInflationException
-
Set the index of the line (0-based) where the error happened.
- setMagicVariablesEnabled(boolean) - Method in class com.actinarium.rhythm.RhythmOverlayInflater
-
Enable or disable “magic variables” support in this inflater instance.
- setMode(int) - Method in class com.actinarium.rhythm.layer.Inset
-
Set inset mode — whether the group should also clip the children, translate the coordinates, or both
- setOffset(int) - Method in class com.actinarium.rhythm.layer.GridLines
-
Set additional grid offset.
- setOverlay(RhythmOverlay) - Method in class com.actinarium.rhythm.RhythmDrawable
-
- setRatio(int, int) - Method in class com.actinarium.rhythm.layer.RatioKeyline
-
Set ratio of the box this keyline should define, in form of two terms
- setRight(int, boolean) - Method in class com.actinarium.rhythm.layer.Inset
-
Set right inset
- setScaleFactor(float) - Method in class com.actinarium.rhythm.layer.DimensionsLabel
-
Set a scale factor that will be applied to width and height of provided bounds
- setState(int[]) - Method in class com.actinarium.rhythm.RhythmDrawable
-
- setStep(float) - Method in class com.actinarium.rhythm.layer.GridLines
-
Set the step of grid lines
- setText(String) - Method in class com.actinarium.rhythm.layer.RatioKeyline
-
Set arbitrary label text to this ratio keyline.
- setTextColor(int) - Method in class com.actinarium.rhythm.layer.DimensionsLabel
-
Set the color of the label text itself
- setTextColor(int) - Method in class com.actinarium.rhythm.layer.RatioKeyline
-
Set ratio keyline label text color
- setTextSize(float) - Method in class com.actinarium.rhythm.layer.DimensionsLabel
-
Set text size
- setThickness(int) - Method in class com.actinarium.rhythm.layer.GridLines
-
Set grid line thickness
- setThickness(int) - Method in class com.actinarium.rhythm.layer.Keyline
-
Set keyline thickness
- setThickness(int) - Method in class com.actinarium.rhythm.layer.RatioKeyline
-
Set ratio keyline thickness
- setTitle(String) - Method in class com.actinarium.rhythm.RhythmOverlay
-
Set the title for this overlay.
- setTop(int, boolean) - Method in class com.actinarium.rhythm.layer.Inset
-
Set top inset
- setWidth(int, boolean) - Method in class com.actinarium.rhythm.layer.Inset
-
Set width.
- SimpleArgumentsBundle - Class in com.actinarium.rhythm
-
A basic implementation of
ArgumentsBundle
, which stores all arguments simply as a String->String key-value
map and parses them into required types when accessed by respective getter methods (meaning it also fails lazily).
- SimpleArgumentsBundle(Map<String, String>, DisplayMetrics) - Constructor for class com.actinarium.rhythm.SimpleArgumentsBundle
-
Create a new simple arguments bundle implementation from provided key->value map.
- SimpleCacheFactory<T extends RhythmSpecLayer> - Class in com.actinarium.rhythm
-
A decorator for a spec layer factory that performs simple caching of previously inflated layers
- SimpleCacheFactory(RhythmSpecLayerFactory<T>) - Constructor for class com.actinarium.rhythm.SimpleCacheFactory
-
- size() - Method in class com.actinarium.rhythm.AbstractSpecLayerGroup
-
Return the number of children in this layer group