com.atakmap.android.dropdown

Class DropDownReceiver

java.lang.Object

android.content.BroadcastReceiver

com.atakmap.android.dropdown.DropDownReceiver

Direct Known Subclasses:

AbstractSheetDropDown, AttachmentBroadcastReceiver, BullseyeDropDownReceiver, CallForFireBroadcastReceiver, ChatManagerMapComponent.ChatDropDownReceiver, CompassOverlayReceiver, ContactDetailDropdown, ContactPresenceDropdown, CoTInfoBroadcastReceiver, CoTSelector, DangerCloseReceiver, DetailedModelViewerDropdownReceiver, DrawingToolsMapReceiver, DrawingToolsToolbar, DropDownNavigationStack, EmergencyTool, EnterLocationDropDownReceiver, FeatureEditDropdownReceiver, FeaturesDetailsDropdownReceiver, HierarchyListReceiver.HierarchyListDropDown, HostileManagerDropDownReceiver, IconManagerDropdown, ImageDropDownReceiver, ImageGalleryReceiver, ImageMapReceiver, ImportManagerDropdown, JumpBridgeDropDownReceiver, LayersManagerBroadcastReceiver, MedicalLineBroadcastReceiver, ModelDetailsDropdownReceiver, NineLineBroadcastReceiver, RadioDropDownReceiver, RangeAndBearingCircleDropDown, RangeAndBearingDropDown, RecentlyAddedDropDownReceiver, ResectionDropDownReceiver, RouteElevationBroadcastReceiver, RouteMapReceiver.RouteDropDownReceiver, RouteToolbarBroadcastReceiver, RoverDropDownReceiver, SensorDetailsReceiver, SphereImageViewerDropDownReceiver, SpotMapReceiver, TrackHistoryDropDown, VideoBrowserDropDownReceiver, VideoDropDownReceiver, ViewshedDropDownReceiver

public abstract class DropDownReceiver
extends android.content.BroadcastReceiver

Nested Class Summary

Nested classes/interfaces inherited from class android.content.BroadcastReceiver

android.content.BroadcastReceiver.PendingResult

Field Summary

Fields

Modifier and Type	Field and Description
static int	DROPDOWN_STATE_FULLSCREEN
static int	DROPDOWN_STATE_NONE
static int	DROPDOWN_STATE_NORMAL
static double	FIVE_EIGTHS_HEIGHT
static double	FIVE_EIGTHS_WIDTH
static double	FIVE_TWELFTHS_HEIGHT
static double	FIVE_TWELFTHS_WIDTH
static double	FULL_HEIGHT
static double	FULL_WIDTH
static double	HALF_HEIGHT
static double	HALF_WIDTH
static double	HANDLE_THICKNESS_LANDSCAPE
static double	HANDLE_THICKNESS_PORTRAIT
static double	NO_HEIGHT
static double	NO_WIDTH
static double	QUARTER_SCREEN
static double	SEVEN_SIXTEENTH_WIDTH
static double	THIRD_HEIGHT
static double	THIRD_WIDTH
static double	THREE_EIGHTHS_HEIGHT
static double	THREE_EIGHTHS_WIDTH
static double	TWO_THIRDS_HEIGHT
static double	TWO_THIRDS_WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DropDownReceiver(MapView mapView)

Method Summary

Modifier and Type	Method and Description
protected boolean	_showDropDown() To only be called by the DropDownManager
void	callResize(double w, double h)
void	closeDropDown() Close the drop down for this Receiver.
void	dispose() Perform any cleanup activity prior to destruction.
protected abstract void	disposeImpl() Any drop down specific disposal implementation that is performed during the disposal of a drop down.
protected void	dropDownAlreadyExists() Action to take when a dropdown is already open under the stack.
java.lang.String	getAssociationKey() Get the associated settings screen key
int	getBackStackCount() Because there is only one backstack per application we need to keep track of the number each dropdown has.
DropDown	getDropDown() Get current DropDown.
MapView	getMapView() The content view for a MapActivity.
protected void	hideDropDown()
boolean	isClosed() Has the drop down been closed.
boolean	isPortrait() Returns true if the drop down receiver is being used in portrait mode.
boolean	isRetained() Should this drop down be maintained on the stack.
boolean	isTablet() Returns true if the drop down receiver is being used on a tablet.
boolean	isTransient() Check whether this drop-down is flagged as transient See setTransient(boolean) for more info
boolean	isVisible() Check if the dropdown is showing.
protected boolean	onBackButtonPressed() For a dropdown that has told the drop down manager to ignore the back button.
protected void	onStateRequested(int state) Signal for a request by the handle.
protected void	resize(double widthFraction, double heightFraction) Resize the dropdown and open the side pane to fit.
void	setAssociationKey(java.lang.String key) Sets the associated setting screen in the Tools section so if the settings screen is open while this drop down receiver is open and in the foreground, the associated setting screen will be opened.
void	setRetain(boolean retain) Should this drop down be maintained on the stack used in the case of nested drop downs.
protected void	setSelected(MapItem item)
protected void	setSelected(MapItem m, java.lang.String icon) Sets the icon to be used for the specified map item.
protected void	setSelected(MapItem m, java.lang.String icon, boolean closeOnDelete) In order to unify management of the concept of a selected icon within the system, this will manage the selection lifecycle in accordance with the same rules as a drop down.
void	setTransient(boolean isTransient) Flags the drop-down as transient to handle a number of specific cases: - DropDownManager.getTopDropDownKey() ignores this drop-down - Opening this drop-down does not close other drop-downs (even with setRetain(boolean) set to false)
void	showDropDown(Fragment fragment, double lwFraction, double lhFraction, double pwFraction, double phFraction) ignoreBackButton defaults to false.
void	showDropDown(Fragment fragment, double lwFraction, double lhFraction, double pwFraction, double phFraction, boolean ignoreBackButton, boolean switchable) ignoreBackButton defaults to false.
void	showDropDown(Fragment fragment, double lwFraction, double lhFraction, double pwFraction, double phFraction, boolean ignoreBackButton, boolean switchable, DropDown.OnStateListener stateListener) Display the fragment in a side pane.
void	showDropDown(Fragment fragment, double lwFraction, double lhFraction, double pwFraction, double phFraction, DropDown.OnStateListener stateListener) ignoreBackButton defaults to false.
void	showDropDown(android.view.View contentView, double lwFraction, double lhFraction, double pwFraction, double phFraction) ignoreBackButton defaults to false.
void	showDropDown(android.view.View contentView, double lwFraction, double lhFraction, double pwFraction, double phFraction, boolean ignoreBackButton) Produces a dropdown with the ignoreBackButton set, but without a listener.
void	showDropDown(android.view.View contentView, double lwFraction, double lhFraction, double pwFraction, double phFraction, boolean ignoreBackButton, boolean switchable, DropDown.OnStateListener stateListener) Display the view in a side pane.
void	showDropDown(android.view.View contentView, double lwFraction, double lhFraction, double pwFraction, double phFraction, boolean ignoreBackButton, DropDown.OnStateListener stateListener) Display the view in a side pane.
void	showDropDown(android.view.View contentView, double lwFraction, double lhFraction, double pwFraction, double phFraction, com.atakmap.android.dropdown.DropDown.DropDownSide side, boolean ignoreBackButton, boolean switchable, DropDown.OnStateListener stateListener) Display the view in a side pane.
void	showDropDown(android.view.View contentView, double lwFraction, double lhFraction, double pwFraction, double phFraction, DropDown.OnStateListener onCloseListener) /** ignoreBackButton defaults to false.
protected void	unhideDropDown()

Methods inherited from class android.content.BroadcastReceiver

abortBroadcast, clearAbortBroadcast, getAbortBroadcast, getDebugUnregister, getResultCode, getResultData, getResultExtras, goAsync, isInitialStickyBroadcast, isOrderedBroadcast, onReceive, peekService, setDebugUnregister, setOrderedHint, setResult, setResultCode, setResultData, setResultExtras

Methods inherited from class java.lang.Object

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

Field Detail

NO_WIDTH

public static final double NO_WIDTH

See Also:

Constant Field Values

FIVE_TWELFTHS_WIDTH

public static final double FIVE_TWELFTHS_WIDTH

See Also:

Constant Field Values

THIRD_WIDTH

public static final double THIRD_WIDTH

See Also:

Constant Field Values

THREE_EIGHTHS_WIDTH

public static final double THREE_EIGHTHS_WIDTH

See Also:

Constant Field Values

SEVEN_SIXTEENTH_WIDTH

public static final double SEVEN_SIXTEENTH_WIDTH

See Also:

Constant Field Values

HALF_WIDTH

public static final double HALF_WIDTH

See Also:

Constant Field Values

FIVE_EIGTHS_WIDTH

public static final double FIVE_EIGTHS_WIDTH

See Also:

Constant Field Values

TWO_THIRDS_WIDTH

public static final double TWO_THIRDS_WIDTH

See Also:

Constant Field Values

FULL_WIDTH

public static final double FULL_WIDTH

See Also:

Constant Field Values

QUARTER_SCREEN

public static final double QUARTER_SCREEN

See Also:

Constant Field Values

NO_HEIGHT

public static final double NO_HEIGHT

See Also:

Constant Field Values

FIVE_TWELFTHS_HEIGHT

public static final double FIVE_TWELFTHS_HEIGHT

See Also:

Constant Field Values

THIRD_HEIGHT

public static final double THIRD_HEIGHT

See Also:

Constant Field Values

THREE_EIGHTHS_HEIGHT

public static final double THREE_EIGHTHS_HEIGHT

See Also:

Constant Field Values

HALF_HEIGHT

public static final double HALF_HEIGHT

See Also:

Constant Field Values

FIVE_EIGTHS_HEIGHT

public static final double FIVE_EIGTHS_HEIGHT

See Also:

Constant Field Values

TWO_THIRDS_HEIGHT

public static final double TWO_THIRDS_HEIGHT

See Also:

Constant Field Values

FULL_HEIGHT

public static final double FULL_HEIGHT

See Also:

Constant Field Values

HANDLE_THICKNESS_LANDSCAPE

public static final double HANDLE_THICKNESS_LANDSCAPE

See Also:

Constant Field Values

HANDLE_THICKNESS_PORTRAIT

public static final double HANDLE_THICKNESS_PORTRAIT

See Also:

Constant Field Values

DROPDOWN_STATE_FULLSCREEN

public static final int DROPDOWN_STATE_FULLSCREEN

See Also:

Constant Field Values

DROPDOWN_STATE_NORMAL

public static final int DROPDOWN_STATE_NORMAL

See Also:

Constant Field Values

DROPDOWN_STATE_NONE

public static final int DROPDOWN_STATE_NONE

See Also:

Constant Field Values

Constructor Detail

DropDownReceiver

protected DropDownReceiver(MapView mapView)

Method Detail

dispose

public final void dispose()

Perform any cleanup activity prior to destruction. The dropdown will no longer be usable after dispose is called. Subclasses will need to implement disposeImpl for any specific disposal steps. Note: The creator of the drop down is responsible for the disposal.

disposeImpl

protected abstract void disposeImpl()

Any drop down specific disposal implementation that is performed during the disposal of a drop down.

callResize

public void callResize(double w,
                       double h)

showDropDown

public void showDropDown(android.view.View contentView,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction)

ignoreBackButton defaults to false.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(android.view.View contentView,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         DropDown.OnStateListener onCloseListener)

/** ignoreBackButton defaults to false.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(android.view.View contentView,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         boolean ignoreBackButton)

Produces a dropdown with the ignoreBackButton set, but without a listener.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(android.view.View contentView,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         boolean ignoreBackButton,
                         DropDown.OnStateListener stateListener)

Display the view in a side pane.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(android.view.View contentView,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         boolean ignoreBackButton,
                         boolean switchable,
                         DropDown.OnStateListener stateListener)

Display the view in a side pane.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(android.view.View contentView,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         com.atakmap.android.dropdown.DropDown.DropDownSide side,
                         boolean ignoreBackButton,
                         boolean switchable,
                         DropDown.OnStateListener stateListener)

Display the view in a side pane. onDropDownVisible will not be called if the stateListener is registered.

Parameters:

contentView - view to display

lwFraction - fraction of the screen width-wise the view should take in landscape mode.

lhFraction - fraction of the screen height-wise the view should take in landscape mode.

pwFraction - fraction of the screen width-wise the view should take in portrait mode.

phFraction - fraction of the screen height-wise the view should take in portrait mode.

side - side to display the panel on

ignoreBackButton - if true, side pane will not close on back button pressed.

switchable - if true, side pane can be switched from LEFT_SIDE to RIGHT_SIDE in the presence of drop down that will ignore the back button.

stateListener - listens to drop down state changes.

showDropDown

public void showDropDown(Fragment fragment,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction)

ignoreBackButton defaults to false.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(Fragment fragment,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         DropDown.OnStateListener stateListener)

ignoreBackButton defaults to false.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(Fragment fragment,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         boolean ignoreBackButton,
                         boolean switchable)

ignoreBackButton defaults to false.

See Also:

DropDownReceiver#showDropDown(Fragment, double, double, double, double, boolean, boolean, OnStateListener)

showDropDown

public void showDropDown(Fragment fragment,
                         double lwFraction,
                         double lhFraction,
                         double pwFraction,
                         double phFraction,
                         boolean ignoreBackButton,
                         boolean switchable,
                         DropDown.OnStateListener stateListener)

Display the fragment in a side pane. onDropDownVisible will not be called if the stateListener is registered.

Parameters:

fragment - fragment to display.

lwFraction - fraction of the screen width-wise the fragment should take in landscape mode.

lhFraction - fraction of the screen height-wise the fragment should take in landscape mode.

pwFraction - fraction of the screen width-wise the fragment should take in portrait mode.

phFraction - fraction of the screen height-wise the fragment should take in portrait mode.

ignoreBackButton - if true, side pane will not close on back button pressed.

stateListener - listens to drop down state changes.

isRetained

public boolean isRetained()

Should this drop down be maintained on the stack. If it is not retained on the stack, then the next drop down that is opened will dismiss this drop down.

setRetain

public void setRetain(boolean retain)

Should this drop down be maintained on the stack used in the case of nested drop downs. If the dropdown should not be maintained on the stack it will be removed when another drop down is opened.

setTransient

public void setTransient(boolean isTransient)

Flags the drop-down as transient to handle a number of specific cases: - DropDownManager.getTopDropDownKey() ignores this drop-down - Opening this drop-down does not close other drop-downs (even with setRetain(boolean) set to false)

Parameters:

isTransient - True if this drop-down should be flagged as transient

isTransient

public boolean isTransient()

Check whether this drop-down is flagged as transient See setTransient(boolean) for more info

Returns:

True if this drop-down is flagged as transient

setAssociationKey

public void setAssociationKey(java.lang.String key)

Sets the associated setting screen in the Tools section so if the settings screen is open while this drop down receiver is open and in the foreground, the associated setting screen will be opened.

Parameters:

key - Settings screen key

getAssociationKey

public java.lang.String getAssociationKey()

Get the associated settings screen key

Returns:

Settings screen key

onBackButtonPressed

protected boolean onBackButtonPressed()

For a dropdown that has told the drop down manager to ignore the back button. This method will be called in order to inform the dropdown that the back button has been pressed. If the drop down handled the back button, then return true else return false. If the method returns false, then the drop down will be closed on pressing the back button.

onStateRequested

protected void onStateRequested(int state)

Signal for a request by the handle.

Parameters:

state - DROPDOWN_STATE_FULLSCREEN = 2; DROPDOWN_STATE_NORMAL = 1; DROPDOWN_STATE_NONE = 0;

dropDownAlreadyExists

protected void dropDownAlreadyExists()

Action to take when a dropdown is already open under the stack.

closeDropDown

public final void closeDropDown()

Close the drop down for this Receiver.

hideDropDown

protected void hideDropDown()

unhideDropDown

protected void unhideDropDown()

_showDropDown

protected final boolean _showDropDown()

To only be called by the DropDownManager

isVisible

public final boolean isVisible()

Check if the dropdown is showing.

Returns:

true if showing, false if otherwise.

isClosed

public final boolean isClosed()

Has the drop down been closed.

getDropDown

public final DropDown getDropDown()

Get current DropDown.

Returns:

current DropDown

getMapView

public final MapView getMapView()

The content view for a MapActivity.

Returns:

MapView

getBackStackCount

public int getBackStackCount()

Because there is only one backstack per application we need to keep track of the number each dropdown has.

Returns:

the number of items this dropdown has in the backstack.

isTablet

public boolean isTablet()

Returns true if the drop down receiver is being used on a tablet.

Returns:

true if it is a tablet.

isPortrait

public boolean isPortrait()

Returns true if the drop down receiver is being used in portrait mode.

Returns:

true if it is in portrait mode.

resize

protected void resize(double widthFraction,
                      double heightFraction)

Resize the dropdown and open the side pane to fit.

Parameters:

widthFraction - fraction of the screen width-wise the view should take.

heightFraction - fraction of the screen height-wise the view should take.

setSelected

protected void setSelected(MapItem m,
                           java.lang.String icon,
                           boolean closeOnDelete)

In order to unify management of the concept of a selected icon within the system, this will manage the selection lifecycle in accordance with the same rules as a drop down. registration can occur after the drop down is showing. the selection icon will be shown when the drop down is visible the selection icon will be hidden when the drop down is not visible the selection will no longer be managed if the drop down is closed. if the drop down is opened again, a call to register selection must be made.

Parameters:

m - the point map item to use as the selected icon.

icon - the location of the asset to use.

closeOnDelete - Close the drop-down when the selected item is deleted

setSelected

protected void setSelected(MapItem m,
                           java.lang.String icon)

Sets the icon to be used for the specified map item.

Parameters:

m - the map item to be selected.

icon - the string for the icon to be used.

setSelected

protected void setSelected(MapItem item)