com.github.amlcurran.showcaseview

Interface ShowcaseDrawer

All Known Implementing Classes:

MaterialShowcaseDrawer

public interface ShowcaseDrawer

Class to implement your own drawing of a showcase view, should you want more control. See the other implementations for examples

Method Summary

Methods

Modifier and Type	Method and Description
void	drawShowcase(android.graphics.Bitmap buffer, float x, float y, float scaleMultiplier) Draw the showcase.
void	drawToCanvas(android.graphics.Canvas canvas, android.graphics.Bitmap bitmapBuffer) Draw the commands drawn to the canvas.
void	erase(android.graphics.Bitmap bitmapBuffer) Remove all drawing on the bitmap.
float	getBlockedRadius()
int	getShowcaseHeight()
int	getShowcaseWidth()
void	setBackgroundColour(int backgroundColor) Set the background color of the showcase.
void	setShowcaseColour(int color) Sets the value of the showcase color from themes.

Method Detail

setShowcaseColour

void setShowcaseColour(int color)

Sets the value of the showcase color from themes. What this does is dependent on your implementation of drawShowcase(Bitmap, float, float, float)

Parameters:

color - the color supplied in the theme

drawShowcase

void drawShowcase(android.graphics.Bitmap buffer,
                float x,
                float y,
                float scaleMultiplier)

Draw the showcase. How this is performed is up to you!

Parameters:

buffer - the bitmap to draw onto

x - the x position of the point to showcase

y - the y position of the point to showcase

scaleMultiplier - a scale factor. Currently unused

getShowcaseWidth

int getShowcaseWidth()

Returns:

the width of the showcase, used to calculate where to place text

getShowcaseHeight

int getShowcaseHeight()

Returns:

the height of the showcase, used to calculate where to place text

getBlockedRadius

float getBlockedRadius()

Returns:

the radius to block touches outside of, if ShowcaseView.setBlocksTouches(boolean) is set

setBackgroundColour

void setBackgroundColour(int backgroundColor)

Set the background color of the showcase. What this means is up to your implementation, but typically this should be the color used to draw in erase(Bitmap)

erase

void erase(android.graphics.Bitmap bitmapBuffer)

Remove all drawing on the bitmap. Typically, this would do a color fill of the background color. See StandardShowcaseDrawer for an example

Parameters:

bitmapBuffer - the Bitmap to erase drawing from

drawToCanvas

void drawToCanvas(android.graphics.Canvas canvas,
                android.graphics.Bitmap bitmapBuffer)

Draw the commands drawn to the canvas. Typically this is a single implementation, see StandardShowcaseDrawer.

Parameters:

canvas - canvas to draw to

bitmapBuffer - bitmap to draw