Packageat.fhjoanneum.dmt.umj.core.display
Classpublic class DisplayContainerWithNavigationButtons
InheritanceDisplayContainerWithNavigationButtons Inheritance EmbeddedFontSparkGroup Inheritance spark.components.Group
Implements mx.binding.IBindingClient
Subclasses DisplayContainerWithApplicationOnly

IMPORTANT FRAMEWORK CLASS: The DisplayContainerWithApplicationOnly is a subclass of EmbeddedFontSparkGroup and IT IS THE MAIN DISPLAY CONTAINER WITHIN YOUR APPLICATION!!! It has functionality for layer handling and navigation state, switching (with animations) and resetting your application state. It needs the information and instructionlayer and sets the intitial state to the information layer! This component will be the main display component and it provides many methods (public as protected overrideable!) Make sure to head through the most important ones...

Default MXML PropertymxmlContent


Public Properties
 PropertyDefined By
  allLayersHolder : VGroup
DisplayContainerWithNavigationButtons
  allLayersHolderWithoutButtons : Group
DisplayContainerWithNavigationButtons
  applicationDetailsLayer1 : ApplicationDetailsLayer
DisplayContainerWithNavigationButtons
  applicationDetailsLayer2 : ApplicationDetailsLayer
DisplayContainerWithNavigationButtons
  applicationDetailsLayerAlwaysVisible3 : ApplicationDetailsLayerAlwaysVisible
DisplayContainerWithNavigationButtons
  applicationLayer : ApplicationLayer
DisplayContainerWithNavigationButtons
  blackBackgroundLayer : BlackContainer
DisplayContainerWithNavigationButtons
  buttonHome : HomeButton
DisplayContainerWithNavigationButtons
  buttonLeft : BackButton
DisplayContainerWithNavigationButtons
  buttonRight : ForwardButton
DisplayContainerWithNavigationButtons
  buttonsLayer : HGroup
DisplayContainerWithNavigationButtons
  currentLayer : Group
[read-only]
DisplayContainerWithNavigationButtons
  displayHasBeenGenerated : Boolean
[static] [read-only]
DisplayContainerWithNavigationButtons
  hideBlackBackgroundWhenApplicationIsVisible : Boolean = false
DisplayContainerWithNavigationButtons
  informationLayer : InformationLayer
DisplayContainerWithNavigationButtons
  instructionLayer : InstructionLayer
DisplayContainerWithNavigationButtons
  screensaver : ScreenSaverLayer
DisplayContainerWithNavigationButtons
  screensaverLayerVisible : Boolean = false
DisplayContainerWithNavigationButtons
  settings : SettingsUserInterface
DisplayContainerWithNavigationButtons
  settingsLayerVisible : Boolean = false
DisplayContainerWithNavigationButtons
  statesAndEventsAreMaintainedAutomatically : Boolean = true
DisplayContainerWithNavigationButtons
Protected Properties
 PropertyDefined By
  blurScreenSaverAnimation : BlurAnimation
DisplayContainerWithNavigationButtons
  crossFadeAnimationForStates : CrossFadeAnimation
DisplayContainerWithNavigationButtons
  crossSwipeAnimationToTheDown : CrossVerticalSwipeAnimation
DisplayContainerWithNavigationButtons
  crossSwipeAnimationToTheLeft : CrossHorizontalSwipeAnimation
DisplayContainerWithNavigationButtons
  crossSwipeAnimationToTheRight : CrossHorizontalSwipeAnimation
DisplayContainerWithNavigationButtons
  crossSwipeAnimationToTheUp : CrossVerticalSwipeAnimation
DisplayContainerWithNavigationButtons
  _currentLayer : Group
DisplayContainerWithNavigationButtons
  initialLayer : Group
DisplayContainerWithNavigationButtons
  singleFadeAnimation : SingleFadeAnimation
DisplayContainerWithNavigationButtons
Public Methods
 MethodDefined By
  
DisplayContainerWithNavigationButtons()
Constructor.
DisplayContainerWithNavigationButtons
  
callButtonHomeManually():void
DisplayContainerWithNavigationButtons
  
hideScreenSaver():void
hides the screensaver if active
DisplayContainerWithNavigationButtons
  
setDisplayController(linkedDisplayController:BaseDisplayController):void
DisplayContainerWithNavigationButtons
  
showLayer(layer:Group, swipe_enabled:Boolean = false, swipe_direction:String = left, overrideDurationInMS:Number = 0):void
EXTEMELY IMPORTANT: show a specific layer and makes it the current - all with a smooth transition if needed! - swipe_direction can be left, right, up, down!
DisplayContainerWithNavigationButtons
  
showScreenSaver():void
shows the screensaver and resets the display to the beginning - awaits input.
DisplayContainerWithNavigationButtons
  
toogleKeyboardEventListeners(value:Boolean):void
DisplayContainerWithNavigationButtons
Protected Methods
 MethodDefined By
  
applicationDetailsLayer1DisabledAnimationComplete(e:AnimationEvent):void
DisplayContainerWithNavigationButtons
  
applicationDetailsLayer2DisabledAnimationComplete(e:AnimationEvent):void
DisplayContainerWithNavigationButtons
  
buttonHome_clickHandler(event:MouseEvent):void
Click Handler for the home global default button of the UMJ specific desing thats implemented...
DisplayContainerWithNavigationButtons
  
buttonLeft_clickHandler(event:MouseEvent):void
Click Handler for the left global default button of the UMJ specific desing thats implemented...
DisplayContainerWithNavigationButtons
  
buttonRight_clickHandler(event:MouseEvent):void
Click Handler for the right global default button of the UMJ specific desing thats implemented...
DisplayContainerWithNavigationButtons
  
checkBlackBackground():void
DisplayContainerWithNavigationButtons
  
fadeOutBlackBackground(e:AnimationEvent):void
DisplayContainerWithNavigationButtons
  
initAnimations():void
inits the runtime animation variables
DisplayContainerWithNavigationButtons
  
initialStateDefinition():void
Override this function in your child extended containers to set your preferred initial state and operation after application resets.
DisplayContainerWithNavigationButtons
  
keyboard_KeydownHandler(event:KeyboardEvent):void
also allow keyboard interaction on the default container - but it's only possible if the buttons are visible!
DisplayContainerWithNavigationButtons
  
onCreationComplete(event:FlexEvent):void
This method initializes the component (yeah, the main big one!) and set its initial states, inits runtime vars like animations and dispatches events if needed!
DisplayContainerWithNavigationButtons
  
resetDisplay(resetContainerToInitialState:Boolean = true):void
resets the display after a screensaver snapped or application is dirty.
DisplayContainerWithNavigationButtons
Property Detail
_currentLayerproperty
protected var _currentLayer:Group

allLayersHolderproperty 
public var allLayersHolder:VGroup

This property can be used as the source for data binding.

allLayersHolderWithoutButtonsproperty 
public var allLayersHolderWithoutButtons:Group

This property can be used as the source for data binding.

applicationDetailsLayer1property 
public var applicationDetailsLayer1:ApplicationDetailsLayer

This property can be used as the source for data binding.

applicationDetailsLayer2property 
public var applicationDetailsLayer2:ApplicationDetailsLayer

This property can be used as the source for data binding.

applicationDetailsLayerAlwaysVisible3property 
public var applicationDetailsLayerAlwaysVisible3:ApplicationDetailsLayerAlwaysVisible

This property can be used as the source for data binding.

applicationLayerproperty 
public var applicationLayer:ApplicationLayer

This property can be used as the source for data binding.

blackBackgroundLayerproperty 
public var blackBackgroundLayer:BlackContainer

This property can be used as the source for data binding.

blurScreenSaverAnimationproperty 
protected var blurScreenSaverAnimation:BlurAnimation

buttonHomeproperty 
public var buttonHome:HomeButton

This property can be used as the source for data binding.

buttonLeftproperty 
public var buttonLeft:BackButton

This property can be used as the source for data binding.

buttonRightproperty 
public var buttonRight:ForwardButton

This property can be used as the source for data binding.

buttonsLayerproperty 
public var buttonsLayer:HGroup

This property can be used as the source for data binding.

crossFadeAnimationForStatesproperty 
protected var crossFadeAnimationForStates:CrossFadeAnimation

crossSwipeAnimationToTheDownproperty 
protected var crossSwipeAnimationToTheDown:CrossVerticalSwipeAnimation

crossSwipeAnimationToTheLeftproperty 
protected var crossSwipeAnimationToTheLeft:CrossHorizontalSwipeAnimation

crossSwipeAnimationToTheRightproperty 
protected var crossSwipeAnimationToTheRight:CrossHorizontalSwipeAnimation

crossSwipeAnimationToTheUpproperty 
protected var crossSwipeAnimationToTheUp:CrossVerticalSwipeAnimation

currentLayerproperty 
currentLayer:Group  [read-only]


Implementation
    public function get currentLayer():Group
displayHasBeenGeneratedproperty 
displayHasBeenGenerated:Boolean  [read-only]


Implementation
    public static function get displayHasBeenGenerated():Boolean
hideBlackBackgroundWhenApplicationIsVisibleproperty 
public var hideBlackBackgroundWhenApplicationIsVisible:Boolean = false

informationLayerproperty 
public var informationLayer:InformationLayer

This property can be used as the source for data binding.

initialLayerproperty 
protected var initialLayer:Group

instructionLayerproperty 
public var instructionLayer:InstructionLayer

This property can be used as the source for data binding.

screensaverproperty 
public var screensaver:ScreenSaverLayer

This property can be used as the source for data binding.

screensaverLayerVisibleproperty 
public var screensaverLayerVisible:Boolean = false

This property can be used as the source for data binding.

settingsproperty 
public var settings:SettingsUserInterface

This property can be used as the source for data binding.

settingsLayerVisibleproperty 
public var settingsLayerVisible:Boolean = false

This property can be used as the source for data binding.

singleFadeAnimationproperty 
protected var singleFadeAnimation:SingleFadeAnimation

statesAndEventsAreMaintainedAutomaticallyproperty 
public var statesAndEventsAreMaintainedAutomatically:Boolean = true

Constructor Detail
DisplayContainerWithNavigationButtons()Constructor
public function DisplayContainerWithNavigationButtons()

Constructor.

Method Detail
applicationDetailsLayer1DisabledAnimationComplete()method
protected function applicationDetailsLayer1DisabledAnimationComplete(e:AnimationEvent):void

Parameters

e:AnimationEvent

applicationDetailsLayer2DisabledAnimationComplete()method 
protected function applicationDetailsLayer2DisabledAnimationComplete(e:AnimationEvent):void

Parameters

e:AnimationEvent

buttonHome_clickHandler()method 
protected function buttonHome_clickHandler(event:MouseEvent):void

Click Handler for the home global default button of the UMJ specific desing thats implemented...

Parameters

event:MouseEvent

buttonLeft_clickHandler()method 
protected function buttonLeft_clickHandler(event:MouseEvent):void

Click Handler for the left global default button of the UMJ specific desing thats implemented...

Parameters

event:MouseEvent

buttonRight_clickHandler()method 
protected function buttonRight_clickHandler(event:MouseEvent):void

Click Handler for the right global default button of the UMJ specific desing thats implemented...

Parameters

event:MouseEvent

callButtonHomeManually()method 
public function callButtonHomeManually():void

checkBlackBackground()method 
protected function checkBlackBackground():void

fadeOutBlackBackground()method 
protected function fadeOutBlackBackground(e:AnimationEvent):void

Parameters

e:AnimationEvent

hideScreenSaver()method 
public function hideScreenSaver():void

hides the screensaver if active

initAnimations()method 
protected function initAnimations():void

inits the runtime animation variables

initialStateDefinition()method 
protected function initialStateDefinition():void

Override this function in your child extended containers to set your preferred initial state and operation after application resets.

keyboard_KeydownHandler()method 
protected function keyboard_KeydownHandler(event:KeyboardEvent):void

also allow keyboard interaction on the default container - but it's only possible if the buttons are visible!

Parameters

event:KeyboardEvent

onCreationComplete()method 
protected function onCreationComplete(event:FlexEvent):void

This method initializes the component (yeah, the main big one!) and set its initial states, inits runtime vars like animations and dispatches events if needed!

Parameters

event:FlexEvent

resetDisplay()method 
protected function resetDisplay(resetContainerToInitialState:Boolean = true):void

resets the display after a screensaver snapped or application is dirty. resets to initialStateDefinition and resets ALL the applicationlayers and calls the displayController to reset the application.

Parameters

resetContainerToInitialState:Boolean (default = true)

setDisplayController()method 
public function setDisplayController(linkedDisplayController:BaseDisplayController):void

Parameters

linkedDisplayController:BaseDisplayController

showLayer()method 
public function showLayer(layer:Group, swipe_enabled:Boolean = false, swipe_direction:String = left, overrideDurationInMS:Number = 0):void

EXTEMELY IMPORTANT: show a specific layer and makes it the current - all with a smooth transition if needed! - swipe_direction can be left, right, up, down!

Parameters

layer:Group
 
swipe_enabled:Boolean (default = false)
 
swipe_direction:String (default = left)
 
overrideDurationInMS:Number (default = 0)

showScreenSaver()method 
public function showScreenSaver():void

shows the screensaver and resets the display to the beginning - awaits input.

toogleKeyboardEventListeners()method 
public function toogleKeyboardEventListeners(value:Boolean):void

Parameters

value:Boolean




UMJ-core 1.1.0 teacup - internal API documentation by majodev. Generated via asdocs, ANT and a bunch of ridiculous external-library-path parameters.

Dienstag Mai 14 2013, 04:02 AM +02:00