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

class HTMLText

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.TextBase
              |
              +--xp.controls.HTMLText

class HTMLText
extends TextBase

A HTML only TextField display

The html document can be set either via the text property or by loading using the loadDocument methods


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Field Summary

public static
classInfo: Object
A static class information object

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

Fields inherited from class xp.controls.TextBase

leading, leftMargin, rightMargin, textIndent

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
largeScroll: Number (read, write)
The large scroll value. The default is 30.

public
smallScroll: Number (read, write)
The small scroll value. The default is 5.

public
styleSheet: TextField.StyleSheet (read, write)
Sets the stylesheet to be used by this object.

public
vScrollPolicy: String (read, write)
Indicates whether the vertical scrollbar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

Properties inherited from class xp.controls.TextBase

font, fontBold, fontColor, fontEmbed, fontFamily, fontItalic, fontName, fontSize, fontStyle, fontUnderline, fontWeight, text, textAlign, textDecoration, textWrap

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
HTMLText ( )
Constructor - This should not be called directly.


Method Summary

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

public
loadDocument ( url: String ): Void
Loads the specified document into this control

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

Methods inherited from class xp.controls.TextBase

getTextEllipsis, getTextExtent

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.

Property Documentation

largeScroll

public largeScroll: Number (read, write)
The large scroll value. The default is 30.

smallScroll

public smallScroll: Number (read, write)
The small scroll value. The default is 5.

styleSheet

public styleSheet: TextField.StyleSheet (read, write)
Sets the stylesheet to be used by this object.

Setting this property automatically sets textWrap to true and html enables the Label.

vScrollPolicy

public vScrollPolicy: String (read, write)
Indicates whether the vertical scrollbar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

A string that controls the visibility of vertical scrollbars.
The value of this property can be "on", "off" or "auto".
The value "auto" causes a scrollbar to appear when needed.

Constructor Documentation

HTMLText

public function HTMLText()
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:
xp.system.UIControl.getClass in class xp.system.UIControl

loadDocument

public function loadDocument(url: String): Void
Loads the specified document into this control

Parameters:
url
The url of a html or xml document to load

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