com.github.amlcurran.showcaseview

Class MaterialShowcaseDrawer

java.lang.Object

com.github.amlcurran.showcaseview.MaterialShowcaseDrawer

All Implemented Interfaces:

ShowcaseDrawer

public class MaterialShowcaseDrawer
extends Object
implements ShowcaseDrawer

Constructor Summary

Constructors

Constructor and Description
MaterialShowcaseDrawer(android.content.res.Resources resources)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaterialShowcaseDrawer

public MaterialShowcaseDrawer(android.content.res.Resources resources)

Method Detail

setShowcaseColour

public void setShowcaseColour(int color)

Description copied from interface: ShowcaseDrawer

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

Specified by:

setShowcaseColour in interface ShowcaseDrawer

Parameters:

color - the color supplied in the theme

drawShowcase

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

Description copied from interface: ShowcaseDrawer

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

Specified by:

drawShowcase in interface ShowcaseDrawer

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

public int getShowcaseWidth()

Specified by:

getShowcaseWidth in interface ShowcaseDrawer

Returns:

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

getShowcaseHeight

public int getShowcaseHeight()

Specified by:

getShowcaseHeight in interface ShowcaseDrawer

Returns:

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

getBlockedRadius

public float getBlockedRadius()

Specified by:

getBlockedRadius in interface ShowcaseDrawer

Returns:

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

setBackgroundColour

public void setBackgroundColour(int backgroundColor)

Description copied from interface: ShowcaseDrawer

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 ShowcaseDrawer.erase(Bitmap)

Specified by:

setBackgroundColour in interface ShowcaseDrawer

erase

public void erase(android.graphics.Bitmap bitmapBuffer)

Description copied from interface: ShowcaseDrawer

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

Specified by:

erase in interface ShowcaseDrawer

Parameters:

bitmapBuffer - the Bitmap to erase drawing from

drawToCanvas

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

Description copied from interface: ShowcaseDrawer

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

Specified by:

drawToCanvas in interface ShowcaseDrawer

Parameters:

canvas - canvas to draw to

bitmapBuffer - bitmap to draw