Class fvaswing.components.reader.abstract.FvReader

Implemented Interfaces

LocalisationListener IFrameListener

Description

Abstract implementation for "PlayList reader" component.

Load / save playlist operation used argument name in constructor call to send / retreive data.

See Also

Field Index

DEFAULT_LIST_WITH

Method Index

addDocument(), close(), getDocumentManager(), getLoaderUI(), getName(), hidePlayListAndMenu(), isExternalFileEnabled(), load(), onEnterFrame(), onLocalisationUpdate(), open(), removeDocument(), setLoaderUI(), toString()

Field Detail

DEFAULT_LIST_WITH

static public DEFAULT_LIST_WITH:Number
Default and minimum with for list in embded mode.

Method Detail

open

public function open(item:FvPlayListItem):Void

Opens dialog.

Parameters

item( optional ) item to open at startup.

load

public function load(xmlList:String):Void

Loads a playlist xml file definition.

Opens the dialog too.

Parameters

xmlListrelative path to xml file.

close

public function close():Void

Closes dialog.

hidePlayListAndMenu

public function hidePlayListAndMenu(enabled:Boolean):Void

Hides playlist and menubar controls.

Caution : can't be undo !

getDocumentManager

public function getDocumentManager():FvReaderDocument

Returns current FvReaderDocument instance.

Overrides method to keep strong typing with custom document

addDocument

public function addDocument(item:FvPlayListItem):Void

Adds passed-in FvPlayListItem to playlist.

removeDocument

public function removeDocument(doc:FvPlayListItem):Void

Removes passed-in FvPlayListItem from playlist.

setLoaderUI

public function setLoaderUI(strategy:FvReaderItemLoader):Void

Defines loader view strategy.

Parameters

strategyFvReaderItemLoader strategy

getLoaderUI

public function getLoaderUI():FvReaderItemLoader

Returns loader FvReaderItemLoader.

isExternalFileEnabled

public function isExternalFileEnabled():Boolean

Returns true if user can load file or playlist file using menubar.

onLocalisationUpdate

public function onLocalisationUpdate(event:LocalisationEvent):Void

Triggered when Localisation language change.

Specified By

onLocalisationUpdate() in fever.app.local.LocalisationListener

getName

public function getName():String

Returns reader name.

Also represent the playlist name ( load / save object name ).

toString

public function toString():String

Returns string representation.

onEnterFrame

public function onEnterFrame():Void

Triggers at each displayed frame by the player.
Resizes playlist container.

as2api