Packagecom.keepcore
Classpublic class KCZoomManager
InheritanceKCZoomManager Inheritance mx.containers.Canvas

The KCZoomManager class handles zoom management on the KCZoomManagerContainer component.

Samples & additional information on KCZoomManager on KeepCore website.
Version 1.0.

It displays a interactive mini-map view of the container allowing user to zoom in / zoom out and moves the current zone displayed in the container.
Developpers can control some of the component display and behaviours:

  • Min & Max zoom factor
  • Container thumb display
  • Zoom control buttons display
  • Zoom control slider display
  • Zoom control slider & buttons increments
  • Zoom controls position
  • Zoom factor display & position

    • Note: in the evaluation version, KeepCore logo is shown every minute.


    Public Properties
     PropertyDefined by
      containerThumbDisplayed : Boolean
    Specifies if a thumb of the container is displayed to help selecting the zoomed zone.
    		KCZoomManager
      currentZoomFactor : Number
    Current zoom factor.
    It must be greater or equal to minZoomFactor and lesser or equal to maxZoomFactor.
  • 1 means 100%
  • 0.1 means 10%
  • 10 means 1000%
    		• KCZoomManager
      KCZoomManagerContainerToControl : KCZoomManagerContainer
    The KCZoomManagerContainer component control.
    You have to explicitly set it.

    IMPORTANT NOTE: this container must only contain one child: the container to zoom in / zoom out.
    		KCZoomManager
      maxZoomFactor : Number
    Maximum zoom factor allowed.
    It must be greater than _minZoomFactor.
  • 1 means 100%
  • 0.1 means 10%
  • 10 means 1000%
    		• KCZoomManager
      minZoomFactor : Number
    Minimum zoom factor allowed.
    It must be greater than _maxZoomFactor.
  • 1 means 100%
  • 0.1 means 10%
  • 10 means 1000%
    		• KCZoomManager
      showButtonsHint : Boolean
    Shows/Hides zoom control buttons tooltip.
    		KCZoomManager
      showMoveMouseCursor : Boolean
    Shows/Hides move mouse cursors over the component.
    		KCZoomManager
      smoothImages : Boolean
    Specifies if the component apply a smooth effect on container images to enhance their rendering when zoomed.
    		KCZoomManager
      zoneRespectContainerAspectRatio : Boolean
    Specifies if the controlled zone repects container aspect ration (usefull with containerThumbDisplayed set to true).
    		KCZoomManager
      zoomControlButtonsDisplayed : Boolean
    Specifies if the zoom control buttons are displayed.
    		KCZoomManager
      zoomControlSliderDisplayed : Boolean
    Specifies if the zoom control slider is displayed.
    		KCZoomManager
      zoomControlSnapInterval : Number
    Zoom control snap interval (sliders & buttons).
    		KCZoomManager
      zoomControlsPosition : String
    The zoom controls position.
    		KCZoomManager
      zoomFactorDisplayed : Boolean
    Specifies if the zoom factor label is displayed.
    		KCZoomManager
      zoomFactorPosition : String
    The zoom factor position.
    		KCZoomManager
    Public Methods
     MethodDefined by
      
    KCZoomManager()
    Class constructor.
    		KCZoomManager
      
    styleChanged(styleProp:String):void
    Overriden styleChanged method.
    Apply styles.
    		KCZoomManager
      
    updateZoom():void
    Force a redraw after a zoom factor change in order to update UI & update controlled container.
    		KCZoomManager
    Protected Methods
     MethodDefined by
      
    createChildren():void
    Overriden createChildren method.
    		KCZoomManager
      
    updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
    Overriden updateDisplayList method.
    		KCZoomManager
    Events
     EventSummaryDefined by
      
    thumbDisplayed
    		Dispatched when a handle (other than rotate one) is clicked.KCZoomManager
    Styles
     StyleDescriptionDefined by
      
    containerBackgroundColor
    		Type: uint   Format: Color   CSS Inheritance: no
    Background color of the container component. The default value is #BBBBBB.    		KCZoomManager
      
    mapControlBackgroundColor
    		Type: uint   Format: Color   CSS Inheritance: no
    Background color of the map control component. The default value is #0068CC.    		KCZoomManager
      
    zoomControlBackgroundColor
    		Type: uint   Format: Color   CSS Inheritance: no
    Background color of the zoom controls. The default value is #000000.    		KCZoomManager
    Public Constants
     ConstantDefined by
      BOTTOM : String = "bottom"
    [static]
    		KCZoomManager
      BOTTOM_LEFT : String = "bottomLeft"
    [static]
    		KCZoomManager
      BOTTOM_RIGHT : String = "bottomRight"
    [static]
    		KCZoomManager
      CONTAINER_BACKGROUND_COLOR_STYLE : String = "containerBackgroundColor"
    [static]
    		KCZoomManager
      EVENT_THUMB_DISPLAYED : String = "thumbDisplayed"
    [static]
    		KCZoomManager
      LEFT : String = "left"
    [static]
    		KCZoomManager
      MAPCONTROL_BACKGROUND_COLOR_STYLE : String = "mapControlBackgroundColor"
    [static]
    		KCZoomManager
      RIGHT : String = "right"
    [static]
    		KCZoomManager
      TOP : String = "top"
    [static]
    		KCZoomManager
      TOP_LEFT : String = "topLeft"
    [static]
    		KCZoomManager
      TOP_RIGHT : String = "topRight"
    [static]
    		KCZoomManager
      ZOOM_CONTROL_BACKGROUND_COLOR_STYLE : String = "zoomControlBackgroundColor"
    [static]
    		KCZoomManager
    Property detail
    containerThumbDisplayedproperty
    containerThumbDisplayed:Boolean  [read-write]

    Specifies if a thumb of the container is displayed to help selecting the zoomed zone.

    The default value is true.

    Implementation
        public function get containerThumbDisplayed():Boolean
        public function set containerThumbDisplayed(value:Boolean):void
    currentZoomFactorproperty 
    currentZoomFactor:Number  [read-write]

    Current zoom factor.
    It must be greater or equal to minZoomFactor and lesser or equal to maxZoomFactor.

  • 1 means 100%
  • 0.1 means 10%
  • 10 means 1000%

    • The default value is 1.

    Implementation
        public function get currentZoomFactor():Number
        public function set currentZoomFactor(value:Number):void
    KCZoomManagerContainerToControlproperty 
    KCZoomManagerContainerToControl:KCZoomManagerContainer  [read-write]

    The KCZoomManagerContainer component control.
    You have to explicitly set it.

    IMPORTANT NOTE: this container must only contain one child: the container to zoom in / zoom out.

    The default value is null.

    Implementation
        public function get KCZoomManagerContainerToControl():KCZoomManagerContainer
        public function set KCZoomManagerContainerToControl(value:KCZoomManagerContainer):void
    maxZoomFactorproperty 
    maxZoomFactor:Number  [read-write]

    Maximum zoom factor allowed.
    It must be greater than _minZoomFactor.

  • 1 means 100%
  • 0.1 means 10%
  • 10 means 1000%

    • The default value is 10.

    Implementation
        public function get maxZoomFactor():Number
        public function set maxZoomFactor(value:Number):void
    minZoomFactorproperty 
    minZoomFactor:Number  [read-write]

    Minimum zoom factor allowed.
    It must be greater than _maxZoomFactor.

  • 1 means 100%
  • 0.1 means 10%
  • 10 means 1000%

    • The default value is 0.2.

    Implementation
        public function get minZoomFactor():Number
        public function set minZoomFactor(value:Number):void
    showButtonsHintproperty 
    showButtonsHint:Boolean  [read-write]

    Shows/Hides zoom control buttons tooltip.

    The default value is false.

    Implementation
        public function get showButtonsHint():Boolean
        public function set showButtonsHint(value:Boolean):void
    showMoveMouseCursorproperty 
    showMoveMouseCursor:Boolean  [read-write]

    Shows/Hides move mouse cursors over the component.

    The default value is false.

    Implementation
        public function get showMoveMouseCursor():Boolean
        public function set showMoveMouseCursor(value:Boolean):void
    smoothImagesproperty 
    smoothImages:Boolean  [read-write]

    Specifies if the component apply a smooth effect on container images to enhance their rendering when zoomed.

    The default value is true.

    Implementation
        public function get smoothImages():Boolean
        public function set smoothImages(value:Boolean):void
    zoneRespectContainerAspectRatioproperty 
    zoneRespectContainerAspectRatio:Boolean  [read-write]

    Specifies if the controlled zone repects container aspect ration (usefull with containerThumbDisplayed set to true).

    The default value is true.

    Implementation
        public function get zoneRespectContainerAspectRatio():Boolean
        public function set zoneRespectContainerAspectRatio(value:Boolean):void
    zoomControlButtonsDisplayedproperty 
    zoomControlButtonsDisplayed:Boolean  [read-write]

    Specifies if the zoom control buttons are displayed.

    The default value is true.

    Implementation
        public function get zoomControlButtonsDisplayed():Boolean
        public function set zoomControlButtonsDisplayed(value:Boolean):void
    zoomControlSliderDisplayedproperty 
    zoomControlSliderDisplayed:Boolean  [read-write]

    Specifies if the zoom control slider is displayed.

    The default value is true.

    Implementation
        public function get zoomControlSliderDisplayed():Boolean
        public function set zoomControlSliderDisplayed(value:Boolean):void
    zoomControlSnapIntervalproperty 
    zoomControlSnapInterval:Number  [read-write]

    Zoom control snap interval (sliders & buttons). It must be greater than 0.

    IMPORTANT NOTE: You have to insure that your settings are coherent with other zoom control propserties.
    ex: if minZoomFactor is 0.2 & zoomControlSnapInterval is 0.5, zoom factor 1 will be unreachable...

    The default value is 0.2.

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

    Implementation
        public function get zoomControlSnapInterval():Number
        public function set zoomControlSnapInterval(value:Number):void
    zoomControlsPositionproperty 
    zoomControlsPosition:String  [read-write]

    The zoom controls position. Defines where the controls (slider & buttons) are displayed (if any). Possible values are "top", "right", "bottom" and "left".

    The default value is "bottom".

    Implementation
        public function get zoomControlsPosition():String
        public function set zoomControlsPosition(value:String):void
    zoomFactorDisplayedproperty 
    zoomFactorDisplayed:Boolean  [read-write]

    Specifies if the zoom factor label is displayed.

    The default value is true.

    Implementation
        public function get zoomFactorDisplayed():Boolean
        public function set zoomFactorDisplayed(value:Boolean):void
    zoomFactorPositionproperty 
    zoomFactorPosition:String  [read-write]

    The zoom factor position. Defines where the zoom factor label is displayed (if any). Possible values are "topRight", "topLeft", "bottomRight" and "bottomLeft".

    The default value is "topRight".

    Implementation
        public function get zoomFactorPosition():String
        public function set zoomFactorPosition(value:String):void
    Constructor detail
    KCZoomManager()constructor
    public function KCZoomManager()

    Class constructor.

    Method detail
    createChildren()method
    protected override function createChildren():void

    Overriden createChildren method. Initialize UI components.

    styleChanged()method 
    public override function styleChanged(styleProp:String):void

    Overriden styleChanged method.
    Apply styles.

    Parameters
    styleProp:String
    updateDisplayList()method 
    protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

    Overriden updateDisplayList method. Size internal UI components.

    Parameters
    unscaledWidth:Number
     
    unscaledHeight:Number
    updateZoom()method 
    public function updateZoom():void

    Force a redraw after a zoom factor change in order to update UI & update controlled container.

    Event detail
    thumbDisplayedevent 
    Event object type: flash.events.Event

    Dispatched when a handle (other than rotate one) is clicked.

    Constant detail
    BOTTOMconstant
    public static const BOTTOM:String = "bottom"
    BOTTOM_LEFTconstant 
    public static const BOTTOM_LEFT:String = "bottomLeft"
    BOTTOM_RIGHTconstant 
    public static const BOTTOM_RIGHT:String = "bottomRight"
    CONTAINER_BACKGROUND_COLOR_STYLEconstant 
    public static const CONTAINER_BACKGROUND_COLOR_STYLE:String = "containerBackgroundColor"
    EVENT_THUMB_DISPLAYEDconstant 
    public static const EVENT_THUMB_DISPLAYED:String = "thumbDisplayed"
    LEFTconstant 
    public static const LEFT:String = "left"
    MAPCONTROL_BACKGROUND_COLOR_STYLEconstant 
    public static const MAPCONTROL_BACKGROUND_COLOR_STYLE:String = "mapControlBackgroundColor"
    RIGHTconstant 
    public static const RIGHT:String = "right"
    TOPconstant 
    public static const TOP:String = "top"
    TOP_LEFTconstant 
    public static const TOP_LEFT:String = "topLeft"
    TOP_RIGHTconstant 
    public static const TOP_RIGHT:String = "topRight"
    ZOOM_CONTROL_BACKGROUND_COLOR_STYLEconstant 
    public static const ZOOM_CONTROL_BACKGROUND_COLOR_STYLE:String = "zoomControlBackgroundColor"



    Copyright (c) 2004-2009 KeepCore, All rights reserved