Package | com.dwuser.ss4.ui.extras |
Class | public class NoteBox |
Inheritance | NoteBox UIComponent FlexSprite flash.display.Sprite |
<note ... />
child node(s) of an <img>
node in the image galleries XML.
The element has a border and, by default, a transparent background. When hovered over, a tooltip as defined by the NoteBoxTooltip
element is shown, providing
information about a specific spot on an image. The properties shown below can be applied to any <note ... />
node associated with an image node.
Default element size is 100 x 100.
Layout XML Syntax Example:
The following example shows a <note ... />
node which is within an <img>
node in the image galleries section of the XML configuration file.
The NoteBox class inherits all of the tag attributes of its superclass.
... <img ... > <note Properties (Inherited) toolTip="No default value" Styles backgroundColor="#000000" backgroundAlpha="0" backgroundDisabledColor="undefined" backgroundImage="undefined" backgroundSize="auto" borderColor="#B7BABC" borderSides="left right top bottom" borderStyle="solid" borderThickness="1" cornerRadius="0" dropShadowEnabled="false" dropShadowColor="#000000" shadowDirection="center" shadowDistance="2" /> </img> ...
Element Pictorial Example:
See also
Method | Defined by | ||
---|---|---|---|
NoteBox()
| NoteBox | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | ||
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | UIComponent | ||
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | UIComponent | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | ||
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | ||
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| UIComponent | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | ||
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | ||
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | ||
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | ||
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | UIComponent | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
initialize():void
Initializes the internal structure of this component.
| UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | ||
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | ||
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b> ,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | ||
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | ||
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true ,
for all descendants of this component as well. | UIComponent | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | ||
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater() , after a call to
suspendBackgroundProcessing() . | UIComponent | ||
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | ||
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| UIComponent | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | ||
setFocus():void
Sets the focus to this component.
| UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | ||
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| UIComponent | ||
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | ||
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater() ,
until resumeBackgroundProcessing() is called. | UIComponent | ||
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Method | Defined by | ||
---|---|---|---|
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
| UIComponent | ||
attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect.
| UIComponent | ||
childrenCreated():void
Performs any final processing after child objects are created.
| UIComponent | ||
commitProperties():void
Processes the properties set on the component.
| UIComponent | ||
createChildren():void
| NoteBox | ||
createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used.
| UIComponent | ||
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
| UIComponent | ||
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
| UIComponent | ||
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
| UIComponent | ||
initializationComplete():void
Finalizes the initialization of this component.
| UIComponent | ||
initializeAccessibility():void
Initializes this component's accessibility code.
| UIComponent | ||
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | ||
keyDownHandler(event:KeyboardEvent):void
The event handler called for a
keyDown event. | UIComponent | ||
keyUpHandler(event:KeyboardEvent):void
The event handler called for a
keyUp event. | UIComponent | ||
measure():void
| NoteBox | ||
resourcesChanged():void
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a
"change" Event to indicate
that the localized resources have changed in some way. | UIComponent | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
| NoteBox |
Style | Description | Defined by | ||
---|---|---|---|---|
backgroundAlpha
| Type: Number Format: Alpha CSS Inheritance: no Alpha (opacity) level of the color defined by the backgroundColor
property, of the image or SWF file defined by the backgroundImage
style.
Valid values range from 0.0 to 1.0. By default, the background is transparent on this element.
The default value is 0.0 . | NoteBox | ||
backgroundColor
| Type: uint Format: Color CSS Inheritance: no Background color of a component. You can have both a backgroundColor and a
backgroundImage set.
The default value is #000000 . | NoteBox | ||
backgroundDisabledColor
| Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled. The global default value is undefined .
| NoteBox | ||
backgroundImage
| Type: Object Format: File CSS Inheritance: no Background image of a component. This can be an absolute or relative URL or class. You can either have both a backgroundColor and a
backgroundImage set at the same time. The background image is displayed
on top of the background color.
The default value is undefined , meaning "not set".
If this style and the backgroundColor style are undefined,
the component has a transparent background.
| NoteBox | ||
backgroundSize
| Type: String CSS Inheritance: no Scales the image specified by backgroundImage
to different percentage sizes.
A value of "100%" stretches the image
to fit the entire component.
To specify a percentage value, you must include the percent sign (%).
The default value is auto , which maintains
the original size of the image.
| NoteBox | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | |||
borderColor
| Type: uint Format: Color CSS Inheritance: no Color of the border. The default value depends on the component class; if not overridden for the class, the default value is #B7BABC .
The default value is #B7BABC . | NoteBox | ||
borderSides
| Type: String CSS Inheritance: no Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left" , "top" ,
"right" , and "bottom" in any order.
The default value is "left top right bottom" ,
which shows all four sides.
This style is only used when borderStyle is "solid" .
| NoteBox | ||
borderStyle
| Type: String CSS Inheritance: no Bounding box style. The possible values are "none" , "solid" ,
"inset" , and "outset" .
The default value is "solid" .
The default value is solid . | NoteBox | ||
borderThickness
| Type: Number Format: Length CSS Inheritance: no Bounding box thickness. Only used when borderStyle is set to "solid" .
The default value is 1 . | NoteBox | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color brightness of the component. | UIComponent | |||
Type: Number CSS Inheritance: no The color contrast of the component. | UIComponent | |||
cornerRadius
| Type: Number Format: Length CSS Inheritance: no Radius of the border corners. The default value is 0 . | NoteBox | ||
dropShadowColor
| Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow. The default value is #000000 . | NoteBox | ||
dropShadowEnabled
| Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. This style is used with borderStyle="solid" .
The default value is false .
Note: For drop shadows to appear on containers, set
false . | NoteBox | ||
Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | |||
Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | |||
Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | |||
Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
Type: Number CSS Inheritance: no The color hue of the component. | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | |||
Type: Number CSS Inheritance: no The opacity of the component. | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color saturation of the component. | UIComponent | |||
shadowDirection
| Type: String CSS Inheritance: no Direction of the drop shadow. Possible values are "left" , "center" ,
and "right" .
The default value is "center" . | NoteBox | ||
shadowDistance
| Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is 2 . | NoteBox | ||
Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent |
NoteBox | () | constructor |
public function NoteBox()
createChildren | () | method |
protected override function createChildren():void
measure | () | method |
protected override function measure():void
updateDisplayList | () | method |
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Parameters
unscaledWidth:Number |
|
unscaledHeight:Number |