Package library :: Package pyjamas :: Package ui :: Module FlashPanel :: Class FlashPanel
[hide private]
[frames] | no frames]

Class FlashPanel

source code

           object --+        
                    |        
      Panel.PanelBase --+    
                        |    
   object --+           |    
            |           |    
      Applier --+       |    
                |       |    
UIObject.UIObject --+   |    
                    |   |    
        Widget.Widget --+    
                        |    
              Panel.Panel --+
                            |
                           FlashPanel

Instance Methods [hide private]
 
__init__(self, **kwargs)
use this to apply properties as a dictionary, e.g.:
source code
 
onLoad(self) source code
 
getObjectID(self)
Returns: id of the object-tag
source code
 
setObjectID(self, object_id) source code
 
getObjectClass(self)
Returns: class-name of the object-tag
source code
 
setObjectClass(self, object_class) source code
 
getObjectWidth(self)
Returns: width parameter of the object-tag
source code
 
setObjectWidth(self, width) source code
 
getObjectHeight(self)
Returns: height parameter of the object-tag
source code
 
setObjectHeight(self, height) source code
 
getFlashUrl(self)
Returns: url of the flashmovie
source code
 
setFlashUrl(self, flash_url) source code
 
getWmode(self)
Returns: flash parameter wmode
source code
 
setWmode(self, wmode) source code
 
getQuality(self)
Returns: flash parameter quality
source code
 
setQuality(self, quality) source code
 
getMenu(self)
Returns: flash parameter menu
source code
 
setMenu(self, menu) source code
 
getAllowFullscreen(self)
Returns: flash parameter allowfullscreen
source code
 
setAllowFullscreen(self, allowFullscreen) source code
 
getBGColor(self)
Returns: flash parameter bgcolor
source code
 
setBGColor(self, bgcolor) source code
 
getFlashVars(self)
Returns: flash parameter flashvars
source code
 
setFlashVars(self, flashvars) source code
 
__getFlashHTML(self) source code
 
getMovieElement(self)
Returns: element DOM-Object of the object-tag
source code
 
callFlash(self, functionName, arguments=[])
Returns: return value of ExternalInterfaces method
source code
 
toJS(self, list_or_dict)
Returns: javascript array or object
source code
 
flashArgumentsToXML(self, arguments, num)
Returns: result of flashs build in function __flash__argumentsToXML
source code

Inherited from Panel.Panel: adopt, disown

Inherited from Panel.PanelBase: __getitem__, __iter__, __len__, __nonzero__, __setitem__, addIndexedItem, append, clear, doAttachChildren, doDetachChildren, getChildren, getIndexedChild, getWidget, getWidgetCount, getWidgetIndex, setWidget

Inherited from Widget.Widget: getID, getLayoutData, getParent, isAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setContextMenu, setID, setLayoutData, setParent

Inherited from UIObject.UIObject: addStyleDependentName, addStyleName, getAbsoluteLeft, getAbsoluteTop, getClientHeight, getClientWidth, getElement, getHeight, getOffsetHeight, getOffsetWidth, getStyleAttribute, getStyleName, getStylePrimaryName, getTitle, getVisible, getWidth, isVisible, removeStyleDependentName, removeStyleName, setElement, setHeight, setPixelSize, setSize, setStyleAttribute, setStyleName, setTitle, setVisible, setWidth, setzIndex, sinkEvents, unsinkEvents

Inherited from Applier: applyValues, retrieveValues, setDefaults, setElementProperties, updateInstance

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]

Inherited from UIObject.UIObject (private): _getProps

Inherited from Applier (private): _getElementProps

Class Variables [hide private]

Inherited from UIObject.UIObject (private): _props

Inherited from Applier (private): _elem_props

Instance Variables [hide private]
  object_id
id of the object-tag.
  object_class
The class-name of the object-tag.
  object_width
The width-parameter of the object-tag.
  object_height
The height-parameter of the object-tag.
  flash_url
The Flash-Movie url.
  wmode
The flashmovie wmode parameter.
  quality
The flashmovie quality parameter.
  menu
The flashmovie wmode parameter.
  allowScriptAccess
The flashmovie allowscriptaccess parameter.
  allowFullscreen
The flashmovie allowfullscreen parameter.
  bgColor
The flashmovie bgcolor parameter.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

source code 

use this to apply properties as a dictionary, e.g.:

   x = klass(..., StyleName='class-name')

will do:

   x = klass(...)
   x.setStyleName('class-name')

and:

   x = klass(..., Size=("100%", "20px"), Visible=False)

will do:

   x = klass(...)
   x.setSize("100%", "20px")
   x.setVisible(False)
Overrides: object.__init__
(inherited documentation)

onLoad(self)

source code 
Overrides: Widget.Widget.onLoad

getObjectID(self)

source code 
Returns:
id of the object-tag

setObjectID(self, object_id)

source code 
Parameters:
  • object_id - The id of the object-tag

getObjectClass(self)

source code 
Returns:
class-name of the object-tag

setObjectClass(self, object_class)

source code 
Parameters:
  • object_class - The class-name of the object-tag

getObjectWidth(self)

source code 
Returns:
width parameter of the object-tag

setObjectWidth(self, width)

source code 
Parameters:
  • width - The width parameter of the object-tag

getObjectHeight(self)

source code 
Returns:
height parameter of the object-tag

setObjectHeight(self, height)

source code 
Parameters:
  • height - The height parameter of the object-tag

getFlashUrl(self)

source code 
Returns:
url of the flashmovie

setFlashUrl(self, flash_url)

source code 
Parameters:
  • flash_url - The url of the flash_movie

getWmode(self)

source code 
Returns:
flash parameter wmode

setWmode(self, wmode)

source code 
Parameters:
  • wmode - The flash parameter wmode

getQuality(self)

source code 
Returns:
flash parameter quality

setQuality(self, quality)

source code 
Parameters:
  • quality - The flash parameter quality

getMenu(self)

source code 
Returns:
flash parameter menu

setMenu(self, menu)

source code 
Parameters:
  • menu - The flash parameter menu

getAllowFullscreen(self)

source code 
Returns:
flash parameter allowfullscreen

setAllowFullscreen(self, allowFullscreen)

source code 
Parameters:
  • allowFullscreen - The flash parameter allowfullscreen

getBGColor(self)

source code 
Returns:
flash parameter bgcolor

setBGColor(self, bgcolor)

source code 
Parameters:
  • bgcolor - The flash parameter bgcolor

getFlashVars(self)

source code 
Returns:
flash parameter flashvars

setFlashVars(self, flashvars)

source code 
Parameters:
  • flashvars - The flash parameter flashvars

getMovieElement(self)

source code 
Returns:
element DOM-Object of the object-tag

callFlash(self, functionName, arguments=[])

source code 
Parameters:
  • functionName - Methodname of ExternalInterface
  • arguments - List with arguments of ExternalInterfaces method
Returns:
return value of ExternalInterfaces method

toJS(self, list_or_dict)

source code 
Parameters:
  • list_or_dict - A List or a Dictonary

    Converting recrusive Dictonarys and Lists to Javascript Types.

Returns:
javascript array or object

flashArgumentsToXML(self, arguments, num)

source code 
Returns:
result of flashs build in function __flash__argumentsToXML

Instance Variable Details [hide private]

object_id

id of the object-tag. Default: FlashObject

object_class

The class-name of the object-tag. Default: None

object_width

The width-parameter of the object-tag. Default: None

object_height

The height-parameter of the object-tag. Default: None

flash_url

The Flash-Movie url. Default: None

wmode

The flashmovie wmode parameter. Default: None

quality

The flashmovie quality parameter. Default: high

menu

The flashmovie wmode parameter. Default: None

allowScriptAccess

The flashmovie allowscriptaccess parameter. Default: always

allowFullscreen

The flashmovie allowfullscreen parameter. Default: False

bgColor

The flashmovie bgcolor parameter. Default: #FFFFFF (white)