com.facebook.litho

Class Border.Builder

java.lang.Object

com.facebook.litho.Border.Builder

Enclosing class:

Border

public static class Border.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Border	build()
Border.Builder	color(YogaEdge edge, int color) Specifies a color for a specific edge
Border.Builder	colorRes(YogaEdge edge, int colorRes) Specifies a color for a specific edge
Border.Builder	cornerEffect(float radius) Deprecated. Please use radiusPx(int) instead
Border.Builder	dashEffect(float[] intervals, float phase) Applies a dash effect to the border
Border.Builder	discreteEffect(float segmentLength, float deviation) Applies a discrete effect to the border
Border.Builder	pathDashEffect(Path shape, float advance, float phase, PathDashPathEffect.Style style) Applies a path dash effect to the border
Border.Builder	radiusAttr(int attrId) Specifies the border radius for all corners
Border.Builder	radiusAttr(int attrId, int defaultResId) Specifies the border radius for all corners
Border.Builder	radiusAttr(int corner, int attrId, int defaultResId) Specifies the border radius for the given corner
Border.Builder	radiusDip(float radius) Specifies the border radius for all corners
Border.Builder	radiusDip(int corner, float radius) Specifies the border radius for the given corner
Border.Builder	radiusPx(int radius) Specifies the border radius for all corners
Border.Builder	radiusPx(int corner, int radius) Specifies the border radius for the given corner
Border.Builder	radiusRes(int radiusRes) Specifies the border radius for all corners
Border.Builder	radiusRes(int corner, int res) Specifies the border radius for the given corner
Border.Builder	widthAttr(YogaEdge edge, int attrId) Specifies a width for a specific edge
Border.Builder	widthAttr(YogaEdge edge, int attrId, int defaultResId) Specifies a width for a specific edge
Border.Builder	widthDip(YogaEdge edge, float width) Specifies a width for a specific edge
Border.Builder	widthPx(YogaEdge edge, int width) Specifies a width for a specific edge
Border.Builder	widthRes(YogaEdge edge, int widthRes) Specifies a width for a specific edge

Methods inherited from class java.lang.Object

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

Method Detail

widthPx

public Border.Builder widthPx(YogaEdge edge,
                              int width)

Specifies a width for a specific edge

Note: Having a border effect with varying widths per edge is currently not supported

Parameters:

edge - The YogaEdge that will have its width modified

width - The desired width in raw pixels

widthDip

public Border.Builder widthDip(YogaEdge edge,
                               float width)

Specifies a width for a specific edge

Note: Having a border effect with varying widths per edge is currently not supported

Parameters:

edge - The YogaEdge that will have its width modified

width - The desired width in density independent pixels

widthRes

public Border.Builder widthRes(YogaEdge edge,
                               int widthRes)

Specifies a width for a specific edge

Note: Having a border effect with varying widths per edge is currently not supported

Parameters:

edge - The YogaEdge that will have its width modified

widthRes - The desired width resource to resolve

widthAttr

public Border.Builder widthAttr(YogaEdge edge,
                                int attrId)

Specifies a width for a specific edge

Note: Having a border effect with varying widths per edge is currently not supported

Parameters:

edge - The YogaEdge that will have its width modified

attrId - The attribute to resolve a width value from

widthAttr

public Border.Builder widthAttr(YogaEdge edge,
                                int attrId,
                                int defaultResId)

Specifies a width for a specific edge

Note: Having a border effect with varying widths per edge is currently not supported

Parameters:

edge - The YogaEdge that will have its width modified

attrId - The attribute to resolve a width value from

defaultResId - Default resource value to utilize if the attribute is not set

radiusPx

public Border.Builder radiusPx(int radius)

Specifies the border radius for all corners

Parameters:

radius - The desired border radius for all corners

radiusDip

public Border.Builder radiusDip(float radius)

Specifies the border radius for all corners

Parameters:

radius - The desired border radius for all corners

radiusRes

public Border.Builder radiusRes(int radiusRes)

Specifies the border radius for all corners

Parameters:

radiusRes - The resource id to retrieve the border radius value from

radiusAttr

public Border.Builder radiusAttr(int attrId)

Specifies the border radius for all corners

Parameters:

attrId - The attribute id to retrieve the border radius value from

radiusAttr

public Border.Builder radiusAttr(int attrId,
                                 int defaultResId)

Specifies the border radius for all corners

Parameters:

attrId - The attribute id to retrieve the border radius value from

defaultResId - Default resource to utilize if the attribute is not set

radiusPx

public Border.Builder radiusPx(int corner,
                               int radius)

Specifies the border radius for the given corner

Parameters:

corner - The Border.Corner to specify the radius of

radius - The desired radius

radiusDip

public Border.Builder radiusDip(int corner,
                                float radius)

Specifies the border radius for the given corner

Parameters:

corner - The Border.Corner to specify the radius of

radius - The desired radius

radiusRes

public Border.Builder radiusRes(int corner,
                                int res)

Specifies the border radius for the given corner

Parameters:

corner - The Border.Corner to specify the radius of

res - The desired dimension resource to use for the radius

radiusAttr

public Border.Builder radiusAttr(int corner,
                                 int attrId,
                                 int defaultResId)

Specifies the border radius for the given corner

Parameters:

corner - The Border.Corner to specify the radius of

attrId - The attribute ID to retrieve the radius from

defaultResId - Default resource ID to use if the attribute is not set

color

public Border.Builder color(YogaEdge edge,
                            int color)

Specifies a color for a specific edge

Parameters:

edge - The YogaEdge that will have its color modified

color - The raw color value to use

colorRes

public Border.Builder colorRes(YogaEdge edge,
                               int colorRes)

Specifies a color for a specific edge

Parameters:

edge - The YogaEdge that will have its color modified

colorRes - The color resource to use

dashEffect

public Border.Builder dashEffect(float[] intervals,
                                 float phase)

Applies a dash effect to the border

Specifying two effects will compose them where the first specified effect acts as the outer effect and the second acts as the inner path effect, e.g. outer(inner(path))

Parameters:

intervals - Must be even-sized >= 2. Even indices specify "on" intervals and odd indices specify "off" intervals

phase - Offset into the given intervals

cornerEffect

@Deprecated
public Border.Builder cornerEffect(float radius)

Deprecated. Please use radiusPx(int) instead

Applies a corner effect to the border

Parameters:

radius - The amount to round sharp angles when drawing the border

discreteEffect

public Border.Builder discreteEffect(float segmentLength,
                                     float deviation)

Applies a discrete effect to the border

Specifying two effects will compose them where the first specified effect acts as the outer effect and the second acts as the inner path effect, e.g. outer(inner(path))

Parameters:

segmentLength - Length of line segments

deviation - Maximum amount of deviation. Utilized value is random in the range [-deviation, deviation]

pathDashEffect

public Border.Builder pathDashEffect(Path shape,
                                     float advance,
                                     float phase,
                                     PathDashPathEffect.Style style)

Applies a path dash effect to the border

Specifying two effects will compose them where the first specified effect acts as the outer effect and the second acts as the inner path effect, e.g. outer(inner(path))

Parameters:

shape - The path to stamp along

advance - The spacing between each stamp

phase - Amount to offset before the first stamp

style - How to transform the shape at each position

build

public Border build()