Cue.Builder

Kotlin |Java

@UnstableApi
class Cue.Builder

A builder for Cue objects.

Summary

Public constructors
`Builder()`

Public functions
`Cue!`	`build()` Build the cue.
`Cue.Builder!`	`@CanIgnoreReturnValue clearWindowColor()` Sets `windowColorSet` to false.
`Boolean`	`isWindowColorSet()` Returns true if the fill color of the window is set.
`Cue.Builder!`	`@CanIgnoreReturnValue setLine(line: Float, @Cue.LineType lineType: Int)` Sets the position of the cue box within the viewport in the direction orthogonal to the writing direction.
`Cue.Builder!`	`@CanIgnoreReturnValue setMultiRowAlignment(multiRowAlignment: Layout.Alignment?)` Sets the multi-row alignment of the cue.
`Cue.Builder!`	`@CanIgnoreReturnValue setShearDegrees(shearDegrees: Float)` Sets the shear angle for this Cue.
`Cue.Builder!`	`@CanIgnoreReturnValue setTextSize(textSize: Float, @Cue.TextSizeType textSizeType: Int)` Sets the default text size and type for this cue's text.

Public properties
`Bitmap?`	`bitmap`
`Float`	`bitmapHeight`
`Float`	`line`
`Int`	`@Cue.AnchorType lineAnchor`
`Int`	`@Cue.LineType lineType`
`Float`	`position`
`Int`	`@Cue.AnchorType positionAnchor`
`Float`	`size`
`CharSequence?`	`text`
`Layout.Alignment?`	`textAlignment`
`Float`	`textSize`
`Int`	`@Cue.TextSizeType textSizeType`
`Int`	`@Cue.VerticalType verticalType`
`@ColorInt Int`	`windowColor`
`Int`	`zIndex`

Builder()

fun build(): Cue!

Build the cue.

@CanIgnoreReturnValue
fun clearWindowColor(): Cue.Builder!

Sets windowColorSet to false.

fun isWindowColorSet(): Boolean

Returns true if the fill color of the window is set.

See also
`windowColorSet`

@CanIgnoreReturnValue
fun setLine(line: Float, @Cue.LineType lineType: Int): Cue.Builder!

Sets the position of the cue box within the viewport in the direction orthogonal to the writing direction.

See also
`line`
`lineType`

@CanIgnoreReturnValue
fun setMultiRowAlignment(multiRowAlignment: Layout.Alignment?): Cue.Builder!

Sets the multi-row alignment of the cue.

Passing null means the alignment is undefined.

See also
`multiRowAlignment`

@CanIgnoreReturnValue
fun setShearDegrees(shearDegrees: Float): Cue.Builder!

Sets the shear angle for this Cue.

@CanIgnoreReturnValue
fun setTextSize(textSize: Float, @Cue.TextSizeType textSizeType: Int): Cue.Builder!

Sets the default text size and type for this cue's text.

See also
`textSize`
`textSizeType`

var bitmap: Bitmap?

var bitmapHeight: Float

val line: Float

@Cue.AnchorType
var lineAnchor: Int

@Cue.LineType
val lineType: Int

var position: Float

@Cue.AnchorType
var positionAnchor: Int

var size: Float

var text: CharSequence?

var textAlignment: Layout.Alignment?

@Cue.TextSizeType
val textSizeType: Int

@Cue.VerticalType
var verticalType: Int

var windowColor: @ColorInt Int

var zIndex: Int