Package | feathers.controls |
Class | public class WebView |
Inheritance | WebView ![]() ![]() |
flash.media.StageWebView
class.
Warning: This component is only compatible with Adobe AIR. It cannot be used with Adobe Flash Player in a web browser.
See also
Property | Defined By | ||
---|---|---|---|
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean | FeathersControl | |
isHistoryBackEnabled : Boolean [read-only]
Indicates if the web view can navigate back in its history. | WebView | ||
isHistoryForwardEnabled : Boolean [read-only]
Indicates if the web view can navigate forward in its history. | WebView | ||
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
isSupported : Boolean [static] [read-only]
Indicates if this component is supported on the current platform. | WebView | ||
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
location : String [read-only]
The URL of the currently loaded page. | WebView | ||
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
title : String [read-only]
The title of the currently loaded page. | WebView | ||
useNative : Boolean
Determines if the system native web browser control is used or if
Adobe AIR's embedded version of the WebKit engine is used. | WebView | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
WebView()
Constructor. | WebView | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | FeathersControl | |
historyBack():void
Navigates to the previous page in the browsing history. | WebView | ||
historyForward():void
Navigates to the next page in the browsing history. | WebView | ||
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
loadString(text:String, mimeType:String = text/html):void
Renders the specified HTML or XHTML string. | WebView | ||
loadURL(url:String):void
Loads the specified URL. | WebView | ||
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
reload():void
Reloads the currently loaded page. | WebView | ||
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
stop():void
Stops the current page from loading. | WebView | ||
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | WebView | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
createStageWebView():void
Creates the StageWebView instance. | WebView | ||
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN
that may be overridden in subclasses to perform additional actions
when the component receives focus. | FeathersControl | |
![]() | focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | FeathersControl | |
![]() | initialize():void
Called the first time that the UI control is added to the stage, and
you should override this function to customize the initialization
process. | FeathersControl | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl | |
stageWebView_completeHandler(event:Event):void | WebView |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when a URL has finished loading with loadURL() or a string has finished loading with loadString(). | WebView | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
Indicates that an error occurred in the StageWebView. | WebView | |||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
Indicates that the location property has changed. | WebView | |||
![]() | Dispatched when the width or height of the control changes. | FeathersControl |
isHistoryBackEnabled | property |
isHistoryBackEnabled:Boolean
[read-only] Indicates if the web view can navigate back in its history.
public function get isHistoryBackEnabled():Boolean
See also
isHistoryForwardEnabled | property |
isHistoryForwardEnabled:Boolean
[read-only] Indicates if the web view can navigate forward in its history.
public function get isHistoryForwardEnabled():Boolean
See also
isSupported | property |
isSupported:Boolean
[read-only] Indicates if this component is supported on the current platform.
public static function get isSupported():Boolean
location | property |
location:String
[read-only] The URL of the currently loaded page.
public function get location():String
See also
title | property |
title:String
[read-only] The title of the currently loaded page.
public function get title():String
See also
useNative | property |
useNative:Boolean
Determines if the system native web browser control is used or if Adobe AIR's embedded version of the WebKit engine is used.
Note: Although it is not prohibited, with some content, failures can occur when the same process uses both the embedded and the system WebKit, so it is recommended that all StageWebViews in a given application be constructed with the same value for useNative. In addition, as HTMLLoader depends on the embedded WebKit, applications using HTMLLoader should only construct StageWebViews with useNative set to false.
public function get useNative():Boolean
public function set useNative(value:Boolean):void
WebView | () | Constructor |
public function WebView()
Constructor.
autoSizeIfNeeded | () | method |
protected function autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. If the
explicitWidth
or explicitHeight
member
variables are set, those value will be used without additional
measurement. If one is set, but not the other, the dimension with the
explicit value will not be measured, but the other non-explicit
dimension will still need measurement.
Calls setSizeInternal()
to set up the
actualWidth
and actualHeight
member
variables used for layout.
Meant for internal use, and subclasses may override this function with a custom implementation.
ReturnsBoolean |
createStageWebView | () | method |
protected function createStageWebView():void
Creates the StageWebView
instance.
Meant for internal use, and subclasses may override this function with a custom implementation.
historyBack | () | method |
public function historyBack():void
Navigates to the previous page in the browsing history.
See also
historyForward | () | method |
public function historyForward():void
Navigates to the next page in the browsing history.
See also
loadString | () | method |
public function loadString(text:String, mimeType:String = text/html):void
Renders the specified HTML or XHTML string.
Parameters
text:String | |
mimeType:String (default = text/html )
|
See also
loadURL | () | method |
public function loadURL(url:String):void
Loads the specified URL.
Parameters
url:String |
See also
reload | () | method |
public function reload():void
Reloads the currently loaded page.
See also
stageWebView_completeHandler | () | method |
protected function stageWebView_completeHandler(event:Event):void
Parameters
event:Event |
stop | () | method |
public function stop():void
Stops the current page from loading.
See also
complete | Event |
starling.events.Event
starling.events.Event.COMPLETE
Dispatched when a URL has finished loading with loadURL()
or a
string has finished loading with loadString()
.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
See also
error | Event |
starling.events.Event
feathers.events.FeathersEventType.ERROR
Indicates that an error occurred in the StageWebView
.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | The flash.events.ErrorEvent
dispatched by the StageWebView . |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.ERROR
event type is used by
Feathers controls when an error occurs that can be caught and
safely ignored.
locationChange | Event |
starling.events.Event
feathers.events.FeathersEventType.LOCATION_CHANGE
Indicates that the location
property has changed.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.LOCATION_CHANGE
event type is used
by the Feathers WebView
component to indicate that its
location has changed.
See also