Class PTRMapWidgetConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class PTRMapWidgetConfiguration implements Parcelable
Configuration class to construct com.pointrlabs.core.map.views.PTRMapWidgetFragment
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description PTRMapWidgetConfiguration(Parcel parcel)
PTRMapWidgetConfiguration()
-
Method Summary
Modifier and Type Method Description final Boolean
isBlueDotAnimationsEnabled()
Flag to enable/disable blue dot animations final Unit
setBlueDotAnimationsEnabled(Boolean isBlueDotAnimationsEnabled)
Flag to enable/disable blue dot animations final Boolean
isAppBannerEnabled()
final Unit
setAppBannerEnabled(Boolean isAppBannerEnabled)
final Boolean
isJoystickEnabled()
final Unit
setJoystickEnabled(Boolean isJoystickEnabled)
final Boolean
isLocationEnabled()
Flag to set the positioning should be enabled or not final Unit
setLocationEnabled(Boolean isLocationEnabled)
Flag to set the positioning should be enabled or not final Boolean
isPathFindingEnabled()
Flag to set the path finding should be enabled or not false - navigate button is hidden from route summary view true - navigate button is shown in route summary view to begin pathfinding final Unit
setPathFindingEnabled(Boolean isPathFindingEnabled)
Flag to set the path finding should be enabled or not false - navigate button is hidden from route summary view true - navigate button is shown in route summary view to begin pathfinding final Boolean
isSearchEnabled()
Flag to set default search functionality should be enabled or not final Unit
setSearchEnabled(Boolean isSearchEnabled)
Flag to set default search functionality should be enabled or not final Boolean
isQuickAccessEnabled()
final Unit
setQuickAccessEnabled(Boolean isQuickAccessEnabled)
final Boolean
isRouteSummaryEnabled()
Flag to set the screen that displays the path steps should be displayed before starting the path finding or not final Unit
setRouteSummaryEnabled(Boolean isRouteSummaryEnabled)
Flag to set the screen that displays the path steps should be displayed before starting the path finding or not final Boolean
isBuildingLevelSelectorEnabled()
Flag to set default building/level selection functionality should be enabled or not false - level selector view is hiddentrue - level selector view is shown final Unit
setBuildingLevelSelectorEnabled(Boolean isBuildingLevelSelectorEnabled)
Flag to set default building/level selection functionality should be enabled or not false - level selector view is hiddentrue - level selector view is shown final Boolean
isLoadingViewEnabled()
Flag to enable/disable displaying loading view upon user interaction or API call that requires data fetch false - loading view is hiddentrue - loading view is shown final Unit
setLoadingViewEnabled(Boolean isLoadingViewEnabled)
Flag to enable/disable displaying loading view upon user interaction or API call that requires data fetch false - loading view is hiddentrue - loading view is shown final Boolean
isExitButtonShown()
Flag to enable/disable displaying exit button on map final Unit
setExitButtonShown(Boolean isExitButtonShown)
Flag to enable/disable displaying exit button on map final Boolean
isAugmentingRealityEnabled()
Flag that determines whether augmenting reality is enabled. final Unit
setAugmentingRealityEnabled(@Deprecated(message = "Has no use") Boolean isAugmentingRealityEnabled)
Flag that determines whether augmenting reality is enabled. final Boolean
isToastMessagesEnabled()
Flag to enable/disable toast messages final Unit
setToastMessagesEnabled(Boolean isToastMessagesEnabled)
Flag to enable/disable toast messages final Boolean
getShouldFocusOnFirstUserLocation()
final Unit
setShouldFocusOnFirstUserLocation(Boolean shouldFocusOnFirstUserLocation)
final Boolean
isPoiDetailViewEnabled()
Flag to enable/disable com.pointrlabs.core.map.views.poi.PoiDetailsView final Unit
setPoiDetailViewEnabled(Boolean isPoiDetailViewEnabled)
Flag to enable/disable com.pointrlabs.core.map.views.poi.PoiDetailsView final Boolean
isRouteHeaderViewEnabled()
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationHeaderView displayed on path finding final Unit
setRouteHeaderViewEnabled(Boolean isRouteHeaderViewEnabled)
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationHeaderView displayed on path finding final Boolean
isRouteFooterViewEnabled()
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationFooterView displayed on path finding final Unit
setRouteFooterViewEnabled(Boolean isRouteFooterViewEnabled)
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationFooterView displayed on path finding final Boolean
isMapTrackingModeButtonEnabled()
Flag to enable/disable the PTRMapTrackingModeButton final Unit
setMapTrackingModeButtonEnabled(Boolean isMapTrackingModeButtonEnabled)
Flag to enable/disable the PTRMapTrackingModeButton final Boolean
isMapTrackingModeHandlerEnabled()
Flag to enable/disable default com.pointrlabs.core.map.models.MapTrackingMode switch handling final Unit
setMapTrackingModeHandlerEnabled(Boolean isMapTrackingModeHandlerEnabled)
Flag to enable/disable default com.pointrlabs.core.map.models.MapTrackingMode switch handling final PTRMapOnBoardingConfiguration
getOnBoardingConfiguration()
Variable to configure map onboarding final Unit
setOnBoardingConfiguration(PTRMapOnBoardingConfiguration onBoardingConfiguration)
Variable to configure map onboarding final Integer
getNavigationHeaderUserIcon()
The icon that represents the user on the header's progress view. final Unit
setNavigationHeaderUserIcon(@DrawableRes() Integer navigationHeaderUserIcon)
The icon that represents the user on the header's progress view. final Integer
getNavigationHeaderDestinationIcon()
The icon that represents the destination on the header's progress view. final Unit
setNavigationHeaderDestinationIcon(@DrawableRes() Integer navigationHeaderDestinationIcon)
The icon that represents the destination on the header's progress view. final Boolean
isNavigationHeaderThemeAccentColorEnabled()
A Boolean value that determines whether route header background color is set to theme color. final Unit
setNavigationHeaderThemeAccentColorEnabled(Boolean isNavigationHeaderThemeAccentColorEnabled)
A Boolean value that determines whether route header background color is set to theme color. final Boolean
isSplashScreenEnabled()
final Unit
setSplashScreenEnabled(Boolean isSplashScreenEnabled)
final Boolean
isOnboardingEnabled()
final Unit
setOnboardingEnabled(Boolean isOnboardingEnabled)
final Boolean
isInfoButtonEnabled()
final Unit
setInfoButtonEnabled(Boolean isInfoButtonEnabled)
Unit
writeToParcel(Parcel parcel, Integer flags)
Integer
describeContents()
final static PTRMapWidgetConfiguration
defaultConfiguration()
Constructs a PTRMapWidgetConfiguration with all components and views enabled final static PTRMapWidgetConfiguration
mapOnlyConfiguration()
Constructs a PTRMapWidgetConfiguration that only displays map. final static PTRMapWidgetConfiguration
locationDisabledConfiguration()
Constructs a PTRMapWidgetConfiguration disabling all location related components and views final static PTRMapWidgetConfiguration
pathFindingDisabledConfiguration()
Constructs a PTRMapWidgetConfiguration disabling all path finding related views -
-
Constructor Detail
-
PTRMapWidgetConfiguration
PTRMapWidgetConfiguration(Parcel parcel)
-
PTRMapWidgetConfiguration
PTRMapWidgetConfiguration()
-
-
Method Detail
-
isBlueDotAnimationsEnabled
final Boolean isBlueDotAnimationsEnabled()
Flag to enable/disable blue dot animations
-
setBlueDotAnimationsEnabled
final Unit setBlueDotAnimationsEnabled(Boolean isBlueDotAnimationsEnabled)
Flag to enable/disable blue dot animations
-
isAppBannerEnabled
final Boolean isAppBannerEnabled()
-
setAppBannerEnabled
final Unit setAppBannerEnabled(Boolean isAppBannerEnabled)
-
isJoystickEnabled
final Boolean isJoystickEnabled()
-
setJoystickEnabled
final Unit setJoystickEnabled(Boolean isJoystickEnabled)
-
isLocationEnabled
final Boolean isLocationEnabled()
Flag to set the positioning should be enabled or not
-
setLocationEnabled
final Unit setLocationEnabled(Boolean isLocationEnabled)
Flag to set the positioning should be enabled or not
-
isPathFindingEnabled
final Boolean isPathFindingEnabled()
Flag to set the path finding should be enabled or not false - navigate button is hidden from route summary view true - navigate button is shown in route summary view to begin pathfinding
-
setPathFindingEnabled
final Unit setPathFindingEnabled(Boolean isPathFindingEnabled)
Flag to set the path finding should be enabled or not false - navigate button is hidden from route summary view true - navigate button is shown in route summary view to begin pathfinding
-
isSearchEnabled
final Boolean isSearchEnabled()
Flag to set default search functionality should be enabled or not
-
setSearchEnabled
final Unit setSearchEnabled(Boolean isSearchEnabled)
Flag to set default search functionality should be enabled or not
-
isQuickAccessEnabled
final Boolean isQuickAccessEnabled()
-
setQuickAccessEnabled
final Unit setQuickAccessEnabled(Boolean isQuickAccessEnabled)
-
isRouteSummaryEnabled
final Boolean isRouteSummaryEnabled()
Flag to set the screen that displays the path steps should be displayed before starting the path finding or not
-
setRouteSummaryEnabled
final Unit setRouteSummaryEnabled(Boolean isRouteSummaryEnabled)
Flag to set the screen that displays the path steps should be displayed before starting the path finding or not
-
isBuildingLevelSelectorEnabled
final Boolean isBuildingLevelSelectorEnabled()
Flag to set default building/level selection functionality should be enabled or not false - level selector view is hidden
true - level selector view is shown
-
setBuildingLevelSelectorEnabled
final Unit setBuildingLevelSelectorEnabled(Boolean isBuildingLevelSelectorEnabled)
Flag to set default building/level selection functionality should be enabled or not false - level selector view is hidden
true - level selector view is shown
-
isLoadingViewEnabled
final Boolean isLoadingViewEnabled()
Flag to enable/disable displaying loading view upon user interaction or API call that requires data fetch false - loading view is hidden
true - loading view is shown
-
setLoadingViewEnabled
final Unit setLoadingViewEnabled(Boolean isLoadingViewEnabled)
Flag to enable/disable displaying loading view upon user interaction or API call that requires data fetch false - loading view is hidden
true - loading view is shown
-
isExitButtonShown
final Boolean isExitButtonShown()
Flag to enable/disable displaying exit button on map
-
setExitButtonShown
final Unit setExitButtonShown(Boolean isExitButtonShown)
Flag to enable/disable displaying exit button on map
-
isAugmentingRealityEnabled
final Boolean isAugmentingRealityEnabled()
Flag that determines whether augmenting reality is enabled.
If true, AR button will be placed on the map widget. Tapping this AR button will launch the AR experience when path finding is active.
Default value is
true
.
-
setAugmentingRealityEnabled
final Unit setAugmentingRealityEnabled(@Deprecated(message = "Has no use") Boolean isAugmentingRealityEnabled)
Flag that determines whether augmenting reality is enabled.
If true, AR button will be placed on the map widget. Tapping this AR button will launch the AR experience when path finding is active.
Default value is
true
.
-
isToastMessagesEnabled
final Boolean isToastMessagesEnabled()
Flag to enable/disable toast messages
-
setToastMessagesEnabled
final Unit setToastMessagesEnabled(Boolean isToastMessagesEnabled)
Flag to enable/disable toast messages
-
getShouldFocusOnFirstUserLocation
final Boolean getShouldFocusOnFirstUserLocation()
-
setShouldFocusOnFirstUserLocation
final Unit setShouldFocusOnFirstUserLocation(Boolean shouldFocusOnFirstUserLocation)
-
isPoiDetailViewEnabled
final Boolean isPoiDetailViewEnabled()
Flag to enable/disable com.pointrlabs.core.map.views.poi.PoiDetailsView
-
setPoiDetailViewEnabled
final Unit setPoiDetailViewEnabled(Boolean isPoiDetailViewEnabled)
Flag to enable/disable com.pointrlabs.core.map.views.poi.PoiDetailsView
-
isRouteHeaderViewEnabled
final Boolean isRouteHeaderViewEnabled()
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationHeaderView displayed on path finding
-
setRouteHeaderViewEnabled
final Unit setRouteHeaderViewEnabled(Boolean isRouteHeaderViewEnabled)
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationHeaderView displayed on path finding
-
isRouteFooterViewEnabled
final Boolean isRouteFooterViewEnabled()
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationFooterView displayed on path finding
-
setRouteFooterViewEnabled
final Unit setRouteFooterViewEnabled(Boolean isRouteFooterViewEnabled)
Flag to enable/disable com.pointrlabs.core.map.views.pathfinding.NavigationFooterView displayed on path finding
-
isMapTrackingModeButtonEnabled
final Boolean isMapTrackingModeButtonEnabled()
Flag to enable/disable the PTRMapTrackingModeButton
-
setMapTrackingModeButtonEnabled
final Unit setMapTrackingModeButtonEnabled(Boolean isMapTrackingModeButtonEnabled)
Flag to enable/disable the PTRMapTrackingModeButton
-
isMapTrackingModeHandlerEnabled
final Boolean isMapTrackingModeHandlerEnabled()
Flag to enable/disable default com.pointrlabs.core.map.models.MapTrackingMode switch handling
-
setMapTrackingModeHandlerEnabled
final Unit setMapTrackingModeHandlerEnabled(Boolean isMapTrackingModeHandlerEnabled)
Flag to enable/disable default com.pointrlabs.core.map.models.MapTrackingMode switch handling
-
getOnBoardingConfiguration
final PTRMapOnBoardingConfiguration getOnBoardingConfiguration()
Variable to configure map onboarding
-
setOnBoardingConfiguration
final Unit setOnBoardingConfiguration(PTRMapOnBoardingConfiguration onBoardingConfiguration)
Variable to configure map onboarding
-
getNavigationHeaderUserIcon
final Integer getNavigationHeaderUserIcon()
The icon that represents the user on the header's progress view.
If
null
the default icon is used. Default value isnull
.
-
setNavigationHeaderUserIcon
final Unit setNavigationHeaderUserIcon(@DrawableRes() Integer navigationHeaderUserIcon)
The icon that represents the user on the header's progress view.
If
null
the default icon is used. Default value isnull
.
-
getNavigationHeaderDestinationIcon
final Integer getNavigationHeaderDestinationIcon()
The icon that represents the destination on the header's progress view.
If
null
the default icon is used. Default value isnull
.
-
setNavigationHeaderDestinationIcon
final Unit setNavigationHeaderDestinationIcon(@DrawableRes() Integer navigationHeaderDestinationIcon)
The icon that represents the destination on the header's progress view.
If
null
the default icon is used. Default value isnull
.
-
isNavigationHeaderThemeAccentColorEnabled
final Boolean isNavigationHeaderThemeAccentColorEnabled()
A Boolean value that determines whether route header background color is set to theme color.
If
null
the default value from configuration is usedisNavigationHeaderThemeAccentColor
. Default value isnull
.
-
setNavigationHeaderThemeAccentColorEnabled
final Unit setNavigationHeaderThemeAccentColorEnabled(Boolean isNavigationHeaderThemeAccentColorEnabled)
A Boolean value that determines whether route header background color is set to theme color.
If
null
the default value from configuration is usedisNavigationHeaderThemeAccentColor
. Default value isnull
.
-
isSplashScreenEnabled
final Boolean isSplashScreenEnabled()
-
setSplashScreenEnabled
final Unit setSplashScreenEnabled(Boolean isSplashScreenEnabled)
-
isOnboardingEnabled
final Boolean isOnboardingEnabled()
-
setOnboardingEnabled
final Unit setOnboardingEnabled(Boolean isOnboardingEnabled)
-
isInfoButtonEnabled
final Boolean isInfoButtonEnabled()
-
setInfoButtonEnabled
final Unit setInfoButtonEnabled(Boolean isInfoButtonEnabled)
-
writeToParcel
Unit writeToParcel(Parcel parcel, Integer flags)
-
describeContents
Integer describeContents()
-
defaultConfiguration
final static PTRMapWidgetConfiguration defaultConfiguration()
Constructs a PTRMapWidgetConfiguration with all components and views enabled
-
mapOnlyConfiguration
final static PTRMapWidgetConfiguration mapOnlyConfiguration()
Constructs a PTRMapWidgetConfiguration that only displays map. Other views and components are disabled
-
locationDisabledConfiguration
final static PTRMapWidgetConfiguration locationDisabledConfiguration()
Constructs a PTRMapWidgetConfiguration disabling all location related components and views
-
pathFindingDisabledConfiguration
final static PTRMapWidgetConfiguration pathFindingDisabledConfiguration()
Constructs a PTRMapWidgetConfiguration disabling all path finding related views
-
-
-
-