UGrokItApi.UgiTitleView Class Reference

Overview

UI component meant for the top of the screen, a title bar with the app name and a UgiStatusImageView

Instance Methods

 UgiTitleView (Android.Content.Context context, Android.Util.IAttributeSet attrs)
 Initializes a new instance of the UGrokItApi.UgiTitleView class. More...
 
void SetRightButton (int resourceId, int color, int highlightedResourceId, int highlightedColor, Action handler)
 Set the right button and handler (Android only) More...
 
void SetRightButton (Android.Graphics.Drawables.Drawable drawable, int color, Android.Graphics.Drawables.Drawable highlightedDrawable, int highlightedColor, Action handler)
 Set the right button and handler More...
 
void SetRightButton (Android.Graphics.Bitmap bitmap, int color, Android.Graphics.Bitmap highlightedBitmap, int highlightedColor, Action handler)
 Set the right button and handler via bitmap (Android only) More...
 
override void SetTitleImage (int resourceId)
 Sets the title image via resource ID. More...
 
void SetTitleImage (Android.Graphics.Bitmap bitmap)
 Set the title image via bitmap More...
 
override void SetTitleImage (Android.Graphics.Drawables.Drawable drawable)
 Set the title image via drawable More...
 

Properties

Action BackButtonAction [get, set]
 Code to execute for Back, or null for no back button More...
 
override int ThemeColorOverride [get, set]
 Gets or sets the color for the title view - used for the title and gradient background More...
 
override int TextColorOnThemeColorOverride [get, set]
 Gets or sets the text color to use when the background is the theme color More...
 
override bool UseBackgroundBasedOnThemeColor [get, set]
 whether the view should use a background color based on the UI color More...
 
override bool DisplayWaveAnimationWhileScanning [get, set]
 whether the view should display an animation whiole scanning More...
 
override bool HideBatteryStatusIndicator [get, set]
 Do not display the battery status indicator More...
 
override Boolean BatteryStatusIndicatorDisplayVersionInfoOnTouch [get, set]
 whether to show version information alert when battery status indicator is touched More...
 
override string TheTitle [get, set]
 Gets or sets the title. More...
 
bool TitleImageExists [get]
 See if a title image exists. More...
 

Instance Method Documentation

◆ SetRightButton() [1/3]

void UGrokItApi.UgiTitleView.SetRightButton ( int  resourceId,
int  color,
int  highlightedResourceId,
int  highlightedColor,
Action  handler 
)
inline

Set the right button and handler (Android only)

Parameters
resourceIdResource ID for the right button
colorColor for the image, or null to not change the image color
highlightedResourceIdHighlighted resource ID for the right button
highlightedColorColor for the image when highlighted, or null to not change the image color
handlerHandler for the right button

◆ SetRightButton() [2/3]

void UGrokItApi.UgiTitleView.SetRightButton ( Android.Graphics.Drawables.Drawable  drawable,
int  color,
Android.Graphics.Drawables.Drawable  highlightedDrawable,
int  highlightedColor,
Action  handler 
)
inline

Set the right button and handler

Parameters
drawableDrawable for the right button
colorColor for the image, or null to not change the image color
highlightedDrawableHighlighted drawable for the right button
highlightedColorColor for the image when highlighted, or null to not change the image color
handlerHandler.

◆ SetRightButton() [3/3]

void UGrokItApi.UgiTitleView.SetRightButton ( Android.Graphics.Bitmap  bitmap,
int  color,
Android.Graphics.Bitmap  highlightedBitmap,
int  highlightedColor,
Action  handler 
)
inline

Set the right button and handler via bitmap (Android only)

Parameters
bitmapBitmapfor the right button
colorColor for the image, or null to not change the image color
highlightedBitmapHighlighted bitmap for the right button
highlightedColorColor for the image when highlighted, or null to not change the image color
handlerHandler.

◆ SetTitleImage() [1/3]

override void UGrokItApi.UgiTitleView.SetTitleImage ( int  resourceId)
inline

Sets the title image via resource ID.

Parameters
resourceIdResource identifier.

◆ SetTitleImage() [2/3]

void UGrokItApi.UgiTitleView.SetTitleImage ( Android.Graphics.Bitmap  bitmap)
inline

Set the title image via bitmap

Parameters
bitmapBitmap.

◆ SetTitleImage() [3/3]

override void UGrokItApi.UgiTitleView.SetTitleImage ( Android.Graphics.Drawables.Drawable  drawable)
inline

Set the title image via drawable

Parameters
drawableDrawable.

Property Documentation

◆ BackButtonAction

Action UGrokItApi.UgiTitleView.BackButtonAction
getset

Code to execute for Back, or null for no back button

true if the view uses a background

◆ ThemeColorOverride

override int UGrokItApi.UgiTitleView.ThemeColorOverride
getset

Gets or sets the color for the title view - used for the title and gradient background

Color

◆ TextColorOnThemeColorOverride

override int UGrokItApi.UgiTitleView.TextColorOnThemeColorOverride
getset

Gets or sets the text color to use when the background is the theme color

Color

◆ UseBackgroundBasedOnThemeColor

override bool UGrokItApi.UgiTitleView.UseBackgroundBasedOnThemeColor
getset

whether the view should use a background color based on the UI color

true if the view uses a background

◆ DisplayWaveAnimationWhileScanning

override bool UGrokItApi.UgiTitleView.DisplayWaveAnimationWhileScanning
getset

whether the view should display an animation whiole scanning

true if the view will display the wave animation

◆ HideBatteryStatusIndicator

override bool UGrokItApi.UgiTitleView.HideBatteryStatusIndicator
getset

Do not display the battery status indicator

true to hide the battery status indicator

◆ BatteryStatusIndicatorDisplayVersionInfoOnTouch

override Boolean UGrokItApi.UgiTitleView.BatteryStatusIndicatorDisplayVersionInfoOnTouch
getset

whether to show version information alert when battery status indicator is touched

color

◆ TheTitle

override string UGrokItApi.UgiTitleView.TheTitle
getset

Gets or sets the title.

The title.

◆ TitleImageExists

bool UGrokItApi.UgiTitleView.TitleImageExists
get

See if a title image exists.

true if a title image exists

Constructor & Destructor Documentation

◆ UgiTitleView()

UGrokItApi.UgiTitleView.UgiTitleView ( Android.Content.Context  context,
Android.Util.IAttributeSet  attrs 
)
inline

Initializes a new instance of the UGrokItApi.UgiTitleView class.

Parameters
contextContext.
attrsAttrs.