com.visioglobe.VisioSample.Blocks

Class VgMyInstructionView

java.lang.Object

com.visioglobe.VisioSample.Blocks.VgMyInstructionView

All Implemented Interfaces:

VgMyDisplayable, VgMyInstructionDisplay

public class VgMyInstructionView
extends java.lang.Object
implements VgMyInstructionDisplay

Displays the navigation instructions and way to jump from previous or next ones. You can also customized class and use it to display the full list of instructions.

Constructor Summary

Constructors

Constructor and Description
VgMyInstructionView(Activity pActivity, VgMyInstructionUpdateListener pInstructionUpdateListener, VgMySurfaceView pSurfaceView, FrameLayout pContainerLayout)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the content.
void	createLayout() Create the layout of the view who will be responsible for displaying the navigation instructions.
void	hide() Hides this Object.
void	hideNavigationBar() Hide navigation bar
boolean	isVisible()
void	release() This method should be called when the activity dies to notify that we should release/unregister all VisioDevKit objects, and null out as much references on other objects as possible.
void	setNavigationIcon(VgManeuverType pManeuverType) Set the navigation icon within the view.
void	setNavigationText(java.lang.String pTitleText, java.lang.String pDetailedText, java.lang.String pInstructionNumText, java.lang.String pBasicText) Set the text within the navigation bar.
void	show() Displays this Object.
void	showNavigationBar() Show navigation bar.
protected void	updateNavigationBar(VgINavigationConstRefPtr pNavigation, long pInstructionIndex) Updates the navigation bar according to the navigation object.
void	updateWithInstruction(VgINavigationConstRefPtr pNavigation, long pIndex) Updates this Display with an instruction.

Methods inherited from class java.lang.Object

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

Constructor Detail

VgMyInstructionView

public VgMyInstructionView(Activity pActivity,
                   VgMyInstructionUpdateListener pInstructionUpdateListener,
                   VgMySurfaceView pSurfaceView,
                   FrameLayout pContainerLayout)

Method Detail

createLayout

public void createLayout()

Create the layout of the view who will be responsible for displaying the navigation instructions.

showNavigationBar

public void showNavigationBar()

Show navigation bar.

hideNavigationBar

public void hideNavigationBar()

Hide navigation bar

updateNavigationBar

protected void updateNavigationBar(VgINavigationConstRefPtr pNavigation,
                       long pInstructionIndex)

Updates the navigation bar according to the navigation object. The text for the instruction is computed here.

Parameters:

mNavigation2 - The navigation object

setNavigationText

public void setNavigationText(java.lang.String pTitleText,
                     java.lang.String pDetailedText,
                     java.lang.String pInstructionNumText,
                     java.lang.String pBasicText)

Set the text within the navigation bar.

Parameters:

pTitleText - The navigation instruction title

pDetailedText - Detailed text to be displayed within the navigation bar.

pInstructionNumText - Simple text displayed within the navigation bar which shows which instruction is active.

pBasicText - Basic instruction text.

setNavigationIcon

public void setNavigationIcon(VgManeuverType pManeuverType)

Set the navigation icon within the view.

Parameters:

pManeuverType - The maneuver type to display.

updateWithInstruction

public void updateWithInstruction(VgINavigationConstRefPtr pNavigation,
                         long pIndex)

Description copied from interface: VgMyInstructionDisplay

Updates this Display with an instruction.

Specified by:

updateWithInstruction in interface VgMyInstructionDisplay

Parameters:

pNavigation - The navigation object used.

pIndex - The instruction index to use.

clear

public void clear()

Description copied from interface: VgMyInstructionDisplay

Clears the content.

Specified by:

clear in interface VgMyInstructionDisplay

show

public void show()

Description copied from interface: VgMyDisplayable

Displays this Object. No effect if it is already displayed.

Specified by:

show in interface VgMyDisplayable

hide

public void hide()

Description copied from interface: VgMyDisplayable

Hides this Object. No effect if it is already hidden.

Specified by:

hide in interface VgMyDisplayable

isVisible

public boolean isVisible()

Specified by:

isVisible in interface VgMyDisplayable

Returns:

true if this Object is visible (i.e. shown). false otherwise.

release

public void release()

This method should be called when the activity dies to notify that we should release/unregister all VisioDevKit objects, and null out as much references on other objects as possible.

Specified by:

release in interface VgMyInstructionDisplay