Tooltip (AS 3.0) V. 1.3 Documentation
Properties
| Name | Type | Description |
| autoShow | Boolean | Defines whether the component is visible by default. Example myTooltip.autoShow = true; |
| content | Mixed | Property defines component's content. Options 1. Text:* – XML, Text, HTML 2. Image:* – flash.net.URLRequest or a path to your image as a String. 3. Instance:* 1. String – Class Name 2. Class 3. Display Object Text Example myTooltip.content = "AFC Tooltip Component"; // or // assuming contentStyle.textHTML = true myTooltip.content = "AFC <b>Tooltip</b> Component"; // or myTooltip.content = new XML("<root>some text</root>"); // or myTooltip.content = new AnyType(); // Tooltip will try to get content of toString() method. Image Example import com.afcomponents.tooltip.ContentType; myTooltip.contentStyle.type = ContentType.IMAGE; myTooltip.content = new URLRequest("some_image_url"); // or myTooltip.content = "some_image_url"; Instance Example import com.afcomponents.tooltip.ContentType; myTooltip.contentStyle.type = ContentType.INSTANCE; myTooltip.content = LinkageClassFromLibrary // or // build a sprite var mySprite = new Sprite(); mySprite.graphics.beginFill(0xFF3399); mySprite.graphics.drawRect(0, 0, 100, 30); mySprite.graphics.endFill(); // set tooltip content myTooltip.type = ContentType.INSTANCE; myTooltip.content = mySprite; |
| contentStyle | Object | Defines the style of the displayed content. Properties 1. textColor:Number 2. textFont:String 3. textEmbed:Boolean 4. textSize:Number 5. textHTML:Boolean 6. textAlign:String (left, right, or center) 7. verticalPadding:Number 8. horizontalPadding:Number 9. type:String ( instance, text, or image) 10. autoSize:Boolean 11. scaleContent:Boolean 12. maintainAspectRatio:Boolean Example myTooltip.contentStyle = {textColor: 0xFF0000, textFont: "courier", textEmbed: false, textSize: 12, textHTML: true, textAlign: "left", horizontalPadding: 5, verticalPadding: 5, autoSize: true, scaleContent: false, maintainAspectRatio: false}; |
| drag | Boolean | Defines whether the component follows the mouse by default. Example myTooltip.drag = true; |
| dragBounds | Object | Property defines bounds within which the component should stay. Default values are set to Stage.stageWidth and Stage.stageHeight dimensions. Properties 1. enabled:Boolean 2. global:Boolean 3. x:Number 4. y:Number 5. width:Number 6. height:Number Example myTooltip.dragBounds = {enabled: true, global: false, x:0, width:100, y:0, height:100} |
| dropShadowFilter | Object | Defines the default settings for the drop shadow filter. For more information please see flash.filters.DropShadowFilter. You can apply custom filters to the component by myTooltip.filters = []. Custom filters override dropShadowFilter property. Properties 1. distance:Number 2. angle:Number 3. color:Number 4. alpha:Number 5. blurX:Number 6. blurY:Number 7. strength:Number 8. quality:Number 9. inner:Boolean 10. knockout:Boolean 11. hideObject:Boolean Example myTooltip.dropShadowFilter = {distance:5, angle:45, color:0xff0000, alpha:1, blurX:5, blurY:5, strength:1, quality:1, inner:false, knockout:false, hideObject:false}; Custom Filter Example import flash.filters.DropShadowFilter; var myFilter = new DropShadowFilter(5, 45, 0xFF0000, .75, 5, 5, 1, 1, false, false, false); myTooltip.filters = [myFilter] |
| shapeStyle | Object | Defines component's body style. Properties 1. fill:Boolean 2. fillColor:Number 3. fillGradient:Number [ ActionScript Only ] 4. stroke:Boolean 5. strokeColor:Number 6. strokeThickness:Number 7. cornerRadius:Number Example myTooltip.shapeStyle = {fill:true, fillColor:0xFFFF00ff, stroke:true, strokeColor:0xFF0000ff, strokeThickness: 2, cornerRadius: 5}; |
| tailStyle | Object | Defines component's tail settings. Please note that tail inherits all of its color values from the style property. Properties 1. enabled:Boolean 2. width:Number 3. height:Number 4. offset:Number 5. position:String (top, bottom, left, or right) Example myTooltip.tailStyle = {enabled: true, width: 10, height: 15, offset: 0, position: "left"}; |
| transition | Object | Defines transition settings for show/hide state of the component. Options 1. none: 2. Blur (com.afcomponents.transitions) 3. Fade (com.afcomponents.transitions) Example import com.afcomponents.common.transitions.*; myTooltip.transition = new Fade(); |
| delay | Object | Property defines delay for show() and hide() methods. In other words how much time (seconds) should pass for the component to be displayed after the show() function has been called. Properties 1. enabled:Boolean 2. show:Number 3. hide:Number Example myTooltip.delay = {enabled: true, show:3, hide:0}; |
Methods
| Name | Return Type | Description |
| show( ) | Void | Sets component's visibility to true. Example myTooltip.show(); |
| showNow( ) | Void | Works just like the show() method, the difference is that the delay parameter will get ignored. Example myTooltip.showNow(); |
| hide( ) | Void | Sets component's visibility to false. Example myTooltip.hide(); |
| hideNow( ) | Void | Works just like the hide() method, the difference is that the delay parameter will get ignored. Example myTooltip.hideNow(); |
| moveTo( x:Number, y:Number ) |
Void | Moves component to the specified position. This property resets x and y coordinates. Example myTooltip.moveTo(10,20); |
| addOwner( owner:DisplayObject ) | Void | Adds an owner. Example myTooltip.addOwner(my_mc); |
| removeOwner( owner:DisplayObject ) | Void | Removes Tooltip owner. Example myTooltip.removeOwner(my_mc); |
| setContent( content:*, type:ContentType ) |
Void | Sets the current content of the Tooltip. Content can be text, an image, a sprite, or a class. Example import com.afcomponents.tooltip.ContentType; // text myTooltip.setContent("This is a test.", ContentType.TEXT); // image myTooltip.setContent("images/logo.gif", ContentType.IMAGE); // sprite or class myTooltip.setContent(my_mc, ContentType.INSTANCE); |
Events
| Name | Return Value | Description |
| INITIALIZE | type target |
Triggered when the Tooltip is initialized. Example import com.afcomponents.events.ComponentEvent; function eventHandler(event:ComponentEvent){ trace(event.type); } myTooltip.addEventListener(ComponentEvent.INITIALIZE, eventHandler); |
| CHANGE | type target |
Triggered when any of the component's properties are modified or the component's state changes. Example import com.afcomponents.events.TooltipEvent; import com.afcomponents.tooltip.*; function eventHandler(event:TooltipEvent){ trace(event.type); } myTooltip.addEventListener(TooltipEvent.CHANGE, eventHandler); myTooltip.type = ContentType.TEXT; myTooltip.content = "Tooltip Component v4.0"; |
| DRAG_START | type target |
Triggered once dragging starts. Example import com.afcomponents.events.TooltipEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myTooltip.addEventListener(TooltipEvent.DRAG_START, eventHandler); |
| DRAG | type target |
Triggered whenever component is being dragged. Example import com.afcomponents.events.TooltipEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myTooltip.addEventListener(TooltipEvent.DRAG, eventHandler); |
| DRAG_STOP | type target |
Triggered once dragging ends. Example import com.afcomponents.events.TooltipEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myTooltip.addEventListener(TooltipEvent.DRAG_STOP, eventHandler); |
| START | type target |
Triggered once the transition starts. Example import com.afcomponents.events.AnimationEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myTooltip.transition.addEventListener(AnimationEvent.START, eventHandler); |
| AnimationEvent.PROGRESS | type target |
Triggered while Tooltip in and out transitions happen. Example import com.afcomponents.events.AnimationEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myTooltip.transition.addEventListener(AnimationEvent.PROGRESS, eventHandler); |
| STOP | type target |
Triggered once the transition ends. Example import com.afcomponents.events.AnimationEvent; function eventHandler(event:Event){ trace(event.type); trace(event.target); } myTooltip.transition.addEventListener(AnimationEvent.STOP, eventHandler) |
| OPEN | type target |
Triggered when content loading starts. Example import flash.events.*; import com.afcomponents.tooltip.ContentType; function eventHandler(event:Event){ trace(event.type); } myTooltip.addEventListener(Event.OPEN, eventHandler); myTooltip.setContent('http://www.afcomponents.com/components/img_gallery/img_1.jpg', ContentType.IMAGE); |
| ProgressEvent.PROGRESS | Triggered when load is in progress. Example import flash.events.ProgressEvent; import com.afcomponents.tooltip.*; function eventHandler(event:ProgressEvent){ trace(event.type); } myTooltip.addEventListener(ProgressEvent.PROGRESS, eventHandler); myTooltip.setContent('some_url', ContentType.IMAGE); |
|
| COMPLETE | Triggered when the load is complete. Example import flash.events.Event; import com.afcomponents.tooltip.*; function eventHandler(event:Event){ trace(event.type); } myTooltip.addEventListener(Event.COMPLETE, eventHandler); myTooltip.setContent('some_url', ContentType.IMAGE); |
|
| IO_ERROR | type target |
Triggered when an input or output error occurs that causes content loading to fail. Example import flash.events.*; import com.afcomponents.tooltip.ContentType; function eventHandler(event:IOErrorEvent){ trace(event.type); } myTooltip.addEventListener(IOErrorEvent.IO_ERROR, eventHandler); myTooltip.setContent('http://www.afcomponents.com/components/img_gallery/error_io.jpg', ContentType.IMAGE); |
| SECURITY_ERROR | type target |
Triggered when loading content fails because of a security violation. Example import flash.events.*; import com.afcomponents.tooltip.ContentType; function eventHandler(event:SecurityErrorEvent){ trace(event.type); trace(event.target); } myTooltip.addEventListener(SecurityErrorEvent.SECURITY_ERROR, eventHandler); myTooltip.setContent('image.jpg', ContentType.IMAGE); Note: This isn't a literal example because the URL passed to setContent isn't an actual valid URL. |
