ca.uwaterloo.epad.prompting

Class PromptPopup

java.lang.Object

ca.uwaterloo.epad.prompting.PromptPopup

public class PromptPopup
extends java.lang.Object

This class represents a prompt pop-up message. It uses a set of icons located in folder /data/vector/cue to display multi-touch gestures (these icons were developed by P.J. Onori and can be found here: http://somerandomdude.com/work/cue/).

Version:

1.0

Author:

Dmitry Pyryeskin

See Also:

PromptManager

Field Summary

Fields

Modifier and Type	Field and Description
int	backgroundColour
int	hightlightColour
int	iconColour
static int	LOCATION_BOTTOM_LEFT
static int	LOCATION_BOTTOM_RIGHT
static int	LOCATION_TOP_LEFT
static int	LOCATION_TOP_RIGHT
int	textColour

Constructor Summary

Constructors

Constructor and Description
PromptPopup(int x, int y, java.lang.String iconName) Make a prompt with the given coordinates and icon.
PromptPopup(int x, int y, java.lang.String iconName, java.lang.String text) Make a prompt with the given coordinates, icon and message.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Start the disposal of the prompt.
void	draw() Draw the prompt using the given parameters.
void	hideText() Stop showing the text.
boolean	isInvisible() Get the visibility of the prompt.
void	pause() Pause the prompt.
void	resume() Resume the prompt.
void	setCoordinates(float x, float y) Change the coordinates of the prompt to the given x and y.
void	setCoordinates(int x, int y) Change the coordinates of the prompt to the given x and y.
void	setCoordinates(processing.core.PVector v) Change the coordinates of the prompt to the coordinates of the vector.
void	setIcon(java.lang.String icon) Change the icon to the provided one.
void	setText(java.lang.String text) Change the message to the provided text.

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION_TOP_LEFT

public static final int LOCATION_TOP_LEFT

See Also:

Constant Field Values

LOCATION_TOP_RIGHT

public static final int LOCATION_TOP_RIGHT

See Also:

Constant Field Values

LOCATION_BOTTOM_LEFT

public static final int LOCATION_BOTTOM_LEFT

See Also:

Constant Field Values

LOCATION_BOTTOM_RIGHT

public static final int LOCATION_BOTTOM_RIGHT

See Also:

Constant Field Values

backgroundColour

public int backgroundColour

hightlightColour

public int hightlightColour

iconColour

public int iconColour

textColour

public int textColour

Constructor Detail

PromptPopup

public PromptPopup(int x,
           int y,
           java.lang.String iconName)

Make a prompt with the given coordinates and icon.

Parameters:

x - x-coordinate

y - y-coordinate

iconName - name of the icon file not including the extension .svg

PromptPopup

public PromptPopup(int x,
           int y,
           java.lang.String iconName,
           java.lang.String text)

Make a prompt with the given coordinates, icon and message.

Parameters:

x - x-coordinate

y - y-coordinate

iconName - name of the icon file not including the extension .svg

text - prompt message

Method Detail

draw

public void draw()

Draw the prompt using the given parameters. PropmtManager must be initialised before this function is called.

See Also:

PromptManager.init(PApplet)

pause

public void pause()

Pause the prompt.

resume

public void resume()

Resume the prompt.

dispose

public void dispose()

Start the disposal of the prompt. The prompt will gradually fade out and then will get removed by the draw() function of PromptManager.

See Also:

PromptManager.draw()

setCoordinates

public void setCoordinates(int x,
                  int y)

Change the coordinates of the prompt to the given x and y.

Parameters:

x - x-coordinate

y - y-coordinate

setCoordinates

public void setCoordinates(float x,
                  float y)

Change the coordinates of the prompt to the given x and y.

Parameters:

x - x-coordinate

y - y-coordinate

setCoordinates

public void setCoordinates(processing.core.PVector v)

Change the coordinates of the prompt to the coordinates of the vector.

Parameters:

v - vector

setIcon

public void setIcon(java.lang.String icon)

Change the icon to the provided one.

Parameters:

icon - name of the icon must match one of the .svg files in folder /data/vector/cue and must not contain the extension .svg. For example: setting icon to the string "tap" will load shape from file /data/vector/cue/tap.svg.

setText

public void setText(java.lang.String text)

Change the message to the provided text.

Parameters:

text - text of the message

hideText

public void hideText()

Stop showing the text.

isInvisible

public boolean isInvisible()

Get the visibility of the prompt.

Returns:

true if alpha of the prompt is equal to 0 and false otherwise