Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
xp.controls

class ImageBox

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.Frame
              |
              +--xp.controls.ImageBox

All Known Subclasses: Icon, Slide
class ImageBox
extends Frame

A content loader and container specifically for images.

The ImageBox loads and display the image specifed in it source property. The scaleMode property controls how the image is displayed. This makes this control ideal for acheiving a standardised look for a set of non standard images
A typical use might be as part of data driven article display form where many different articles can be displayed each with its own images which might be of slightly different sizes As with all XPComponents DataBinding support is built in and the source proeprty can be linked ot a data field.

The image source can be a linkageId of a library clip or the url of an external jpg or swf During loading a preload image can be displayed. The prelaod image fades in in proportion to the progress of loading. If preloadId is set to "PreLoadIcon" a flash logo wil be used as the pre load image Once loaded the preloader fades out and the image fades in. This behavior can be turned off via properties. ImageBox does not support scrolling as it sclaes content instead. If you need scroll support see the (@link xp.controls.ScrollPanel}
Event summary for the ImageBox class
The following table lists events of the ImageBox class.

EventTypeDescription
xp.events.ProgressEventprogressTriggered while content is loading.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com Style properties - padding

Field Summary

public static
classInfo: Object
A static class information object

public
styleClass: String
The name of the style class this instance will use.

public
tweenLength: Number
the duration in ms of the transition effect tween

Fields inherited from class xp.controls.Frame

classInfo, hasExternalContent, hasExternalImage, hideImageWhileLoading, isContentLoaded, isContentLoading, preloadMessage

Fields inherited from class xp.system.UIControl

__layout, allowDrop, autoLayout, bindingDefaultValue, bindingFormatter, bindingPath, bindingSource, bindingType, bindingValidator, border, causesValidation, classInfo, clickOnENTER, clickOnSPACE, container, context, data, disableAcceptButton, disableCancelButton, enableBGMouseEvents, enableDblClickEvent, enableKeyDownEvents, enableKeyEvents, enableKeyUpEvents, enableMouseWheelEvents, formatterOptions, horizontalAlignment, index, isBinding, itemId, logEnabled, parent, parentContainer, parentForm, percentageHeight, percentageWidth, styleClass, tabIndex, tabStop, tooltip, tree, verticalAlignment

Property Summary

public
imageAlign: String (read, write)
Controls how the image is aligned to the container

public
scaleMode: String (read, write)
Controls how the image is scaled

public
transitionMode: String (read, write)
Controls how the content transitions from preload to image

Properties inherited from class xp.controls.Frame

alignPreloader, autoload, content, nocache, preloadId, source

Properties inherited from class xp.system.UIControl

alpha, autosize, background, backgroundVisible, bindings, borderBrush, borderRadius, borderShadow, borderStyle, borderThickness, bottom, dataSource, enableMouseEvents, focusManager, height, id, isEnabled, isFocused, isMouseOver, isPressed, isSelected, isValid, layout, left, margin, maxHeight, maxWidth, measuredHeight, measuredMinHeight, measuredMinWidth, measuredWidth, minHeight, minWidth, padding, readOnly, resources, right, styleName, top, triggers, visible, width, x, y

Constructor

public
ImageBox ( )
Constructor - This should not be called directly.


Method Summary

public
getClass ( ): Function
Returns a reference to the components static class

public static
newInstance ( owner, instanceId, depth, initObj )
Creates a new Instance of this class

Methods inherited from class xp.controls.Frame

drawComponent, getClass, loadContent

Methods inherited from class xp.system.UIControl

addBinding, addBindings, addEventListener, addPropertyTrigger, applyStyle, beginDeferUpdate, canUpdate, centerContent, checkState, containsFocus, destroy, destroyObject, drawFocus, endDeferUpdate, findFocusFromObject, findFocusInChildren, getBinding, getBounds, getCenter, getClass, getFocus, getFocusManager, getFocusRect, getLocation, getPropertyValue, getSize, getStateName, getTrigger, globalToLocalPoint, invalidate, invalidateLayout, invalidateSize, invalidateSizeAndLayout, invalidChild, isChild, isMouseDirectlyOver, isParent, localToGlobalPoint, localToLocalPoint, measure, mouseWheel, move, onChildFocus, onKillFocus, onSetFocus, processEnterKey, processEscapeKey, processTabKey, redraw, refresh, removeEventListener, routeEvent, setBounds, setFocus, setLocation, setPropertyValue, setSize, setValueChanged, update, validate


Field Documentation

classInfo

public static var classInfo: Object
A static class information object

Every class has an associated classInfo object that holds the version and other static information. The classInfo can be accessed either directly by referencing the static class or by calling getClass() on any class instance.

styleClass

public var styleClass: String
The name of the style class this instance will use.

tweenLength

public var tweenLength: Number
the duration in ms of the transition effect tween

Property Documentation

imageAlign

public imageAlign: String (read, write)
Controls how the image is aligned to the container

scaleMode

public scaleMode: String (read, write)
Controls how the image is scaled

One of scale,crop,scale-n-crop.
scale The image is scaled to fit the container whilst maintaining aspect ratio. This can result in "whitespace"(the background) if the container aspect ratio is different from the image.
crop The image is not scaled but is cropped to fit the container
scale-n-crop The smallest dimensioni of the image is scaled to fit the container whilst maintaining aspect ratio and any excess is them cropped. In this mode ther can be no "whitespace" but part of the image may be cropped.

transitionMode

public transitionMode: String (read, write)
Controls how the content transitions from preload to image

One of none or fade. If fade the preload fades out and the image fades in.

Constructor Documentation

ImageBox

public function ImageBox()
Constructor - This should not be called directly.

If you want to dynamically create a new instance of a control use its static newInstance method

Method Documentation

getClass

public function getClass(): Function
Returns a reference to the components static class

Overrides:
Frame.getClass in class Frame

newInstance

public static function newInstance(owner,
 instanceId,
 depth,
 initObj)
Creates a new Instance of this class

Creates an instance of a component at runtime. You need to use the import statement and specify the class package name before calling this method. In addition, the component must be in the FLA file’s library.

Parameters:
owner
A reference to the movie clip or object that will contains the new Instance.
instanceId
A string indicating the instance name of the new instance.(optional)
depth
A number indicating the depth of the new instance.(optional)
initObj
An object containing initialization properties for the new instance.(optional)
Returns:
A object that is an instance of the specified class.

The documentation was generated from the following file:

Generated on 10/30/2005 9:34:02 PM by AS2Doc