ActionComponents  04.05.00
Customizable UI and time-saving tools for Android development with Xamarin and Visual Studio.
ActionComponents.ACNavBar Class Reference

A left-side, icon based, customizable navigation strip and view controller More...

Inheritance diagram for ActionComponents.ACNavBar:
Collaboration diagram for ActionComponents.ACNavBar:

Public Member Functions

 ACNavBar (Context context)
 Initializes a new instance of the ActionComponents.ACNavBar class. More...
 
 ACNavBar (Context context, Display display)
 Initializes a new instance of the ActionComponents.ACNavBar class. More...
 
 ACNavBar (Context context, IAttributeSet attrs)
 Initializes a new instance of the ActionComponents.ACNavBar class. More...
 
 ACNavBar (Context context, ACNavBarAppearance appearance)
 Initializes a new instance of the ActionComponents.ACNavBar class. More...
 
ACNavBarButton SelectedButton ()
 Returns the currently selected button in this ActionComponents.ACNavBar More...
 
int SelectedButtonId ()
 Returns the Unique Identifier for the currently selected ActionComponents.ACNavBarButton or zero if no button is selected. More...
 
void SelecteButtonByID (int Id)
 Select the given ActionComponents.ACNavBarButton by the given Id More...
 
void DisplayDefaultView ()
 Causes the selected ActionComponents.ACNavBarButton in the any ActionComponents.ACNavBarButtonCollection to be displayed and raises the buttons Touched event More...
 
void Redraw ()
 Redraw this instance. More...
 

Public Attributes

object tag
 [OPTIONAL] Tag to hold user information about this collection More...
 

Protected Member Functions

override void OnDraw (Android.Graphics.Canvas canvas)
 Raises the draw event. More...
 
override void OnLayout (bool changed, int l, int t, int r, int b)
 Raises the layout event. More...
 

Properties

int rehydrationId [get, set]
 Gets or sets the rehydration identifier used to restore the selected ActionComponents.ACNavBarButton after a state change such as rotation. More...
 
RelativeLayout SuperView [get]
 Returns the SuperView (parent view) of this ActionComponents.ACNavBar More...
 
ACNavBarButtonAppearance buttonAppearanceEnabled [get, set]
 Gets or sets the button appearance enabled values More...
 
ACNavBarButtonAppearance buttonAppearanceDisabled [get, set]
 Gets or sets the button appearance disabled values More...
 
ACNavBarButtonAppearance buttonAppearanceSelected [get, set]
 Gets or sets the button appearance selected values More...
 
ACNavBarAppearance appearance [get, set]
 Controlls the general appearance of the control More...
 
bool pointerHidden [get, set]
 Gets or sets a value indicating whether this ActionComponents.ACNavBar pointer is hidden. More...
 
bool Hidden [get, set]
 Gets or sets a value indicating whether this ActionComponents.ACNavBar is hidden. More...
 
ACNavBarButtonCollection top [get]
 Gets the top ActionComponents.ACNavBarButtonCollection of ActionComponents.ACNavBarButtons More...
 
ACNavBarButtonCollection middle [get]
 Gets the middle ActionComponents.ACNavBarButtonCollection of ActionComponents.ACNavBarButtons More...
 
ACNavBarButtonCollection bottom [get]
 Gets the bottom ActionComponents.ACNavBarButtonCollection of ActionComponents.ACNavBarButtons More...
 
RelativeLayout.LayoutParams layoutParams [get]
 Gets the layout parameters typecast to a RelativeLayout.LayoutParams format More...
 
int LeftMargin [get, set]
 Gets or sets the left margin. More...
 
int TopMargin [get, set]
 Gets or sets the top margin. More...
 
int RightMargin [get, set]
 Gets or sets the right margin. More...
 
int BottomMargin [get, set]
 Gets or sets the bottom margin. More...
 
int LayoutWidth [get, set]
 Gets or sets the width of the layout. More...
 
int LayoutHeight [get, set]
 Gets or sets the height of the layout. More...
 

Detailed Description

A left-side, icon based, customizable navigation strip and view controller

The ActionComponents.ACNavBar has three ActionComponents.ACNavBarButtonCollections (top, middle and bottom) that ActionComponents.ACNavBarButtons can be added to. Several different ActionComponents.ACNavBarButtonTypes can be created that provide automatic control of attached Views to simple touchable buttons to notification icons. The ActionComponents.ACNavBar appearance can be adjusted using ActionComponents.ACNavBarAppearance and ActionComponents.ACNavBarButtonAppearance properties.

Constructor & Destructor Documentation

ActionComponents.ACNavBar.ACNavBar ( Context  context)

Initializes a new instance of the ActionComponents.ACNavBar class.

Parameters
contextContext.
ActionComponents.ACNavBar.ACNavBar ( Context  context,
Display  display 
)

Initializes a new instance of the ActionComponents.ACNavBar class.

Parameters
contextContext.
displayDisplay.
ActionComponents.ACNavBar.ACNavBar ( Context  context,
IAttributeSet  attrs 
)

Initializes a new instance of the ActionComponents.ACNavBar class.

Parameters
contextContext.
attrsAttrs.
ActionComponents.ACNavBar.ACNavBar ( Context  context,
ACNavBarAppearance  appearance 
)

Initializes a new instance of the ActionComponents.ACNavBar class.

Parameters
contextContext.
appearanceAppearance.

Here is the call graph for this function:

Member Function Documentation

void ActionComponents.ACNavBar.DisplayDefaultView ( )

Causes the selected ActionComponents.ACNavBarButton in the any ActionComponents.ACNavBarButtonCollection to be displayed and raises the buttons Touched event

This routine MUST be called in the OnStart method of your Action to properly display View for the currently selected ActionComponents.ACNavBarButton

Here is the call graph for this function:

override void ActionComponents.ACNavBar.OnDraw ( Android.Graphics.Canvas  canvas)
protected

Raises the draw event.

Parameters
canvasCanvas.
override void ActionComponents.ACNavBar.OnLayout ( bool  changed,
int  l,
int  t,
int  r,
int  b 
)
protected

Raises the layout event.

Parameters
changedIf set to true changed.
lL.
tT.
rThe red component.
bThe blue component.
void ActionComponents.ACNavBar.Redraw ( )

Redraw this instance.

Here is the call graph for this function:

Here is the caller graph for this function:

void ActionComponents.ACNavBar.SelecteButtonByID ( int  Id)

Select the given ActionComponents.ACNavBarButton by the given Id

Parameters
IdIdentifier.

Use this routine to restore the NavBar's state after an activity like screen rotation

ACNavBarButton ActionComponents.ACNavBar.SelectedButton ( )

Returns the currently selected button in this ActionComponents.ACNavBar

Returns
Returns the ActionComponents.ACNavBarButton selected or null if no button is selected

Here is the call graph for this function:

Here is the caller graph for this function:

int ActionComponents.ACNavBar.SelectedButtonId ( )

Returns the Unique Identifier for the currently selected ActionComponents.ACNavBarButton or zero if no button is selected.

Returns
The button identifier for the selected button or 0 if no button is selected

Use this routine to save the state of the NavBar before an activity like screen rotation

Here is the call graph for this function:

Member Data Documentation

object ActionComponents.ACNavBar.tag

[OPTIONAL] Tag to hold user information about this collection

Property Documentation

ACNavBarAppearance ActionComponents.ACNavBar.appearance
getset

Controlls the general appearance of the control

ACNavBarButtonCollection ActionComponents.ACNavBar.bottom
get

Gets the bottom ActionComponents.ACNavBarButtonCollection of ActionComponents.ACNavBarButtons

The bottom collection

The bottom ActionComponents.ACNavBarButtonCollection is usually reserved for Settings and Notification ActionComponents.ACNavBarButtonTypes of buttons.

int ActionComponents.ACNavBar.BottomMargin
getset

Gets or sets the bottom margin.

The bottom margin.

ACNavBarButtonAppearance ActionComponents.ACNavBar.buttonAppearanceDisabled
getset

Gets or sets the button appearance disabled values

The button appearance disabled values

Any changes to this appearance will cascade to all ActionComponents.ACNavBarButtonCollections and all ActionComponents.ACNavBarButtons in those collections.

ACNavBarButtonAppearance ActionComponents.ACNavBar.buttonAppearanceEnabled
getset

Gets or sets the button appearance enabled values

The button appearance enabled values

Any changes to this appearance will cascade to all ActionComponents.ACNavBarButtonCollections and all ActionComponents.ACNavBarButtons in those collections.

ACNavBarButtonAppearance ActionComponents.ACNavBar.buttonAppearanceSelected
getset

Gets or sets the button appearance selected values

The button appearance selected values

Any changes to this appearance will cascade to all ActionComponents.ACNavBarButtonCollections and all ActionComponents.ACNavBarButtons in those collections.

bool ActionComponents.ACNavBar.Hidden
getset

Gets or sets a value indicating whether this ActionComponents.ACNavBar is hidden.

true if hidden; otherwise, false.

The ActionComponents.ACNavBar will slide on and off the left edge of the screen when shown or hidden.

int ActionComponents.ACNavBar.LayoutHeight
getset

Gets or sets the height of the layout.

The height of the layout.

RelativeLayout.LayoutParams ActionComponents.ACNavBar.layoutParams
get

Gets the layout parameters typecast to a RelativeLayout.LayoutParams format

The layout parameters.

int ActionComponents.ACNavBar.LayoutWidth
getset

Gets or sets the width of the layout.

The width of the layout.

int ActionComponents.ACNavBar.LeftMargin
getset

Gets or sets the left margin.

The left margin.

ACNavBarButtonCollection ActionComponents.ACNavBar.middle
get

Gets the middle ActionComponents.ACNavBarButtonCollection of ActionComponents.ACNavBarButtons

The middle collection

The middle ActionComponents.ACNavBarButtonCollection is usually reserved for Tool ActionComponents.ACNavBarButtonTypes of buttons that act on the currently selected UIView

bool ActionComponents.ACNavBar.pointerHidden
getset

Gets or sets a value indicating whether this ActionComponents.ACNavBar pointer is hidden.

true if pointer hidden; otherwise, false.

int ActionComponents.ACNavBar.rehydrationId
getset

Gets or sets the rehydration identifier used to restore the selected ActionComponents.ACNavBarButton after a state change such as rotation.

The rehydration identifier.

Call the ActionComponents.ACNavBar.SelectedButtonID method in the OnSaveInstanceState method of your Action to get the value to set this property to.

int ActionComponents.ACNavBar.RightMargin
getset

Gets or sets the right margin.

The right margin.

RelativeLayout ActionComponents.ACNavBar.SuperView
get

Returns the SuperView (parent view) of this ActionComponents.ACNavBar

The containing View or null on error

ACNavBarButtonCollection ActionComponents.ACNavBar.top
get

Gets the top ActionComponents.ACNavBarButtonCollection of ActionComponents.ACNavBarButtons

The top collection

This is the master ActionComponents.ACNavBarButtonCollection. The first button added to this collection will automatically be the selected button. Its UIView will be displayed and the ActionComponents.ACNavBarPointer will be moved into position beside this button. NOTE: You need to call the DisplayDefaultView method of the ActionComponents.ACNavBar to cause the first view to be correctly displayed after the NavBar has been populated with buttons.

int ActionComponents.ACNavBar.TopMargin
getset

Gets or sets the top margin.

The top margin.