<view>
Prev  Views  Next

<view>
The most basic viewable element.

JavaScript: lz.view
extends <node> » lz.Eventable »

The <view> is the most basic viewable element in an OpenLaszlo application. Anything that is displayed on the canvas is a view or extends the view class. A view is a rectangle, which can be visible or invisible, and which can contain other views or display "resources" such as images, .swf files, or other supported media. One view controls one displayable resource. The view system is strictly hierarchical; that is, each view has a single parent but can have multiple children.

The following code shows one view nested inside another: 

<canvas height="50">
   <view width="50" height="50" bgcolor="red">
     <view width="30" height="30" bgcolor="blue"/>
   </view> 
 </canvas>
edit
Flash
edit
HTML5

<view> extends <node>, which is the fundamental abstract class of LZX.

For an introduction to views see the OpenLaszlo tutorials, particularly OpenLaszlo Basics and Introduction to Views. For a more rigorous explanation of views see the Application Developer's Guide, particularly the Views chapter.

Attributes

Name Type (tag) Type (js) Default Category
aaactive boolean Boolean   read/write
  Activate/inactivate children for accessibility
aadescription string String   read/write
  Set accessibility description
aaname string String   read/write
  Set accessibility name
aasilent boolean Boolean   read/write
  Set accessibility silencing/unsilencing
aatabindex number Number   read/write
  Set accessibility tab order
align "left" | "center" | "right" | constraint String "left" read/write
   
backgroundrepeat "repeat" | "repeat-x" | "repeat-y" | "norepeat" String "norepeat" read/write
  Setting backgroundrepeat causes a view to repeat its resource to fit the view's width and/or height. Can be 'repeat', 'repeat-x', 'repeat-y' or 'norepeat' per the CSS1 background-repeat style.
bgcolor color Number null read/write
  The background color of the view. Setting bgcolor to null will make the view transparent. May be set to any valid CSS color specification. When read, will be read as the equivalent numeric value. To retrieve a CSS color specification, use this.presentAttribute('bgcolor', 'color'). Default is null (transparent).
cachebitmap boolean Boolean false read/write
  A value of true means that this view's bitmap will be cached, if available.
capabilities   Object   readonly
  An object containing properties corresponding to the current runtime's capabilities. For example, capabilities.rotation is true in swf and recent versions of Safari and Firefox.
clickable boolean Boolean false read/write
  If true, this view intercepts click events; otherwise they are passed to its container. This defaults to true if the view defines a mouse event handler or a cursor.
clickregion string String   read/write
  Setting to a vector-based resource changes the clickable hotspot for the mouse. Check capabilities.clickregion before using to avoid debugger warnings.
clip boolean Boolean false initialize-only
  Clip the view's contents to its size.
colortransform expression Object   read/write
  color transforms everything contained in the view (except the background) by the transformation dictionary given in o. The dictionary has the following possible keys: o.redMultiplier: multiplier for red component (0 to 1) defaults to 1 o.redOffset: offset for red component (-255 to 255) defaults to 0 o.greenMultiplier: multiplier for green component (0 to 1) defaults to 1 o.greenOffset: offset for green component (-255 to 255) defaults to 0 o.blueMultiplier: multiplier for blue component (0 to 1) defaults to 1 o.blueOffset: offset for blue component (-255 to 255) defaults to 0 o.alphaMultiplier: multiplier for alpha component (0 to 1) defaults to 1 o.alphaOffset: offset for alpha component (-255 to 255) defaults to 0
context expression Object   read/write
  Contains a reference to the raw drawing context. The oncontext event is sent when the context is ready to use, which can take some time in IE DHTML.
contextmenu   lz.contextmenu   read/write
  The current context menu object
cornerradius string String 0 read/write
  The corner radius for the background
cursor token String   read/write
  The cursor to display when the mouse is over this view. Any resource can be used as a cursor. This attribute can be set for any view with clickable=true, or any view whose class defaults clickable to true.
fgcolor color Number 0 read/write
  The foreground color of any <text> or <inputtext> elements that appear inside this view. To apply a color transform, see tintcolor. May be set to any valid CSS color specification. When read, will be read as the equivalent numeric value. To retrieve a CSS color specification, use this.presentAttribute('fgcolor', 'color'). Default is 0 (black).
focusable boolean Boolean false read/write
  If true, this view will receive focus events. See focus manager (lz.Focus) for more details.
focustrap boolean Boolean   read/write
  If true, this view "traps" the focus, for example in a window or dialog. See focus manager (lz.Focus) for more details.
font string String   read/write
  The font to use for any <text> or <inputtext> elements that appear inside this view. Like all the font properties (fontstyle and fontsize too) these properties cascade down the view hierarchy until a new value is specified.
fontsize size Number   read/write
  Pixel size to use to render text which appears inside this view. The default is 8.
fontstyle string String   read/write
  The style to use to render text fields that appear inside of this view. One of "plain", "bold" , "italic" or "bolditalic".
frame numberExpression Number "1" read/write
  If this view has a multi-frame resource, this allows setting which resource frame is displayed. Defaults to the first frame (1). See also the resource attribute. Setting this attribute will change the frame that is being displayed by the resource associated with this view. The first frame of the resource is frame 1. Setting a view's 'donttrackplay' option to true will allow the view's resource to play without updating the value of the view's frame property. This can save CPU usage in cases where the application doesn't need to know what frame the resource is showing while it is playing.
framesloadratio   Number   readonly
  For views whose resource is loaded at runtime, the ratio of the loaded frames to the total frames. This is a number between zero and 1.
hassetheight   Boolean   readonly
  If true, then this view has an assigned or constrained height, and the view will not be sized to its contents.
hassetwidth   Boolean   readonly
  If true, then this view has an assigned or constrained width, and the view will not be sized to its contents.
height sizeExpression *   read/write
  The height of the view. Can be set to either a number, or null, to indicate that the view should be sized to hold its content. When read, reflects the actual size of the view.
layout css Object   read/write
  A CSS declaration of property: value pairs of layout attributes, which are used to create a layout that is attached to this view. If there is a class property, it names the class of the layout to be created, otherwise <simplelayout> is used. Examples: layout="axis: x", layout="class: constantlayout", layout="axis: y", layout="axis: x; spacing: 5".
loadratio   Number   readonly
  For views whose resource is loaded at runtime, ratio of the loaded bytes to the total bytes. This is a number between zero and 1.
mask   lz.view   readonly
  Reference to closest masked view in the hierarchy at or above this one
opacity Number Number "1.0" read/write
  The opacity of the view's contents. 1.0 is opaque; 0.0 is totally transparent (invisible).
pixellock booleanLiteral Boolean   initialize-only
  The view system supports sub-pixel positioning to enable smooth animation. This may be turned off to make the view snap to a pixel boundary by setting pixellock to true.
playing boolean Boolean false readonly
  If true, this view is currently playing.
proxyurl expression any function read/write
  The url of the proxy server, if the app is running in proxied mode. proxyurl can be null, a URL string, or a function.
  • If the value is a string, treat it as a URL to the proxy server.
  • If the value is a function, it should return the URL of the proxy server.
The default proxy policy references the proxyurl of the canvas.
resource string String   read/write
  A resource that is presented in the background of this view. The value can be either the name of a resource defined with the resource tag, a URL, or a pathname. If the value is a URL, the resource is requested when the view is displayed. If it's a pathname, the file named by the pathname is compiled into the application, and attached to this view.
resourceheight number Number   readonly
  The height of the resource that this view attached
resourcewidth number Number   readonly
  The width of the resource that this view attached
rotation numberExpression Number "0" read/write
  The rotation value for the view (in degrees). Value may be less than zero or greater than 360.
shadowangle number Number 0 read/write
  The angle for the drop shadow, in degrees
shadowblurradius number Number 4 read/write
  The blur radius for the drop shadow, in pixels
shadowcolor color Number 0 read/write
  The color for the drop shadow
shadowdistance number Number 10 read/write
  The distance for the drop shadow, in pixels
showhandcursor boolean Boolean   read/write
  Show or hide the hand cursor for this view, if clickable
source string String   read/write
  The URL from which to load the resource for this view. If this attribute is set, the media for the view is loaded at runtime.
stretches "width" | "height" | "both" | "none" String "none" read/write
  Setting stretches causes a view to change its coordinate space so that everything it contains (resources and other views) fit exactly into the view's width and/or height. The default for this property is "none". This is used to resize a view's contents by setting its width and/or height.
subviews   [lz.view]   readonly
  An array of the subviews that are children of this view. This is initialized to an empty array for views that have no subviews.
tintcolor string String   read/write
  Sets the color offset, based on a hexadecimal color string, e.g. '#ff00ff'. See setColorTransform() for details.
totalframes   Number   readonly
  The total number of frames for this view's resource.
unstretchedheight   Number   readonly
  If stretches is not set to none, the height that this view would be if it weren't stretched. This attribute can be used to scale a view by a percentage of its original size, or to determine the aspect ratio for a view.
unstretchedwidth   Number   readonly
  If stretches is not set to none, the width that this view would be if it weren't stretched. This attribute can be used to scale a view by a percentage of its original size, or to determine the aspect ratio for a view.
usegetbounds boolean Boolean false readonly
  True if this view requires a call to getBounds() for accurate width and height measurement. This may be necessary when an offset or rotation are applied.
valign "top" | "middle" | "bottom" | constraint String "top" read/write
  Creates a constraint on the view's y position which is a function of its height and its parent's height. The default for this is "top".
visibility string String "collapse" read/write
  A value of "visible" means that this view is shown. A value of "hidden" means that this view is hidden. Setting this attribute to "collapse" means that the runtime will hide this view when: its opacity is zero, it has a datapath that does not match a node, or it is loading its media. In this case, the the value of the 'visible' attribute of the view will reflect the view's current visible state.
visible boolean Boolean "true" read/write
  A value of true means that this view is shown. A value of false means that this view is hidden. Note that an otherwise clickable view that is not visible will have no click region and will not be clickable.
width sizeExpression *   read/write
  The width of the view. Can be set to either a number, or null, to indicate that the view should be sized to hold its content. When read, reflects the actual size of the view.
x numberExpression Number "0" read/write
  The horizontal offset of this view's upper left corner from the upper left corner of its container.
xoffset numberExpression Number "0" read/write
  Specifies a translation point for drawing of this view. If the xoffset is set, then rotation and x position will be calculated by first adding the xoffset.
xscale numberExpression Number "1" read/write
  Specifies this horizontal scale for this and all child views.
y numberExpression Number "0" read/write
  The vertical offset of this view's upper left corner from the upper left corner of its container
yoffset numberExpression Number "0" read/write
  Specifies a translation point for drawing of this view. If the yoffset is set, then rotation and y position will be calculated by first adding the yoffset.
yscale numberExpression Number "1" read/write
  Specifies this vertical scale for this and all child views.

Attributes inherited from <node>

classroot, cloneManager, datapath, defaultplacement, id, ignoreplacement, immediateparent, inited, initstage, name, nodeLevel, options, parent, placement, styleclass, subnodes, transition

Methods

bringToFront()
view.bringToFront();
This method makes this view the frontmost subview of this view's parent.
containsPt()
view.containsPt(x : Number, y : Number);
returns true if the point is contained within the view. Considers visibility and clipping.
Parameter Name Type Description
x Number an x value relative to the this view's coordinates
y Number an y value relative to the this view's coordinates
Returns Type Description
  Boolean boolean indicating whether or not the point lies within the view
getAttributeRelative()
view.getAttributeRelative(prop : String, refView : lz.view);

Transform the specified attribute from this view's coordinate space to the reference view's coordinate space. This operation works for any two views on the canvas, regardless of their relative relationship.

This method answers these questions: For x or y: What value of x or y in the reference view will be the same absolute position as my current x or y? For width or height: What distance in the x or y axis in the reference view will be the same absolute distance as my current width or height.

See also lz.view.setAttributeRelative . this.setAttributeRelative(property, that) is the same as (but more efficient than) this.setAttribute(property, that.getAttributeRelative(property, this)).

Parameter Name Type Description
prop String the property to transform: 'x', 'y', 'width', or 'height'
refView lz.view the view where the transformed property is measured
getBounds()
view.getBounds();
Returns an Object with x, y, width, and height properties that are the coordinates of the view's bounding box in its immediateparent's coordinate system. The OpenLaszlo view object uses a relatively simple notion for its coordinate system. Note that this function doesn't necessarily return the true bounding box of the view, but a box surrounding the view, since this method respects a set width and/or height and ignores subviews that appear left or above of the view's 0,0 point. The xoffset and yoffset properties of the bounds object are the distance between the view's x or y property and the top or left of the bounding box.
Returns Type Description
  Object An object with x, y, width, height, xoffset and yoffset properties that describes the bounding box of the view.
getColor()
view.getColor();
Gets the color of the view (the view's resource and any subviews) view as as set with setColor(). Returns A color in rgb format; for example, 0xff0000 is red. @deprecated
getColorTransform() (swf8)
view.getColorTransform();
[Caution] This method is deprecated
Use colortransform attribute instead.
Returns an object that represents the color transformation currently applied to the view. The color transform object has the following possible keys o.ra: percentage alpha for red component (-100 to 100); o.rb: offset for red component (-255 to 255); o.ga: percentage alpha for green component (-100 to 100); o.gb: offset for green component (-255 to 255); o.ba: percentage alpha for blue component (-100 to 100); o.bb: offset for blue component (-255 to 255); o.aa: percentage overall alpha (-100 to 100); o.ab: overall offset (-255 to 255);
getContextMenu()
view.getContextMenu();
[Caution] This method is deprecated
Use 'view.contextmenu' instead
Returns the current context menu object
getCurrentTime()
view.getCurrentTime();
Return the elapsed play time within the view's resource.
Returns Type Description
  Number The number of seconds of media between the current frame and the first frame
getDepthList()
view.getDepthList();
Returns an array of subviews in depth order
Returns Type Description
  [lz.view] An array of this view's subviews in depth order
getDisplayObject()
view.getDisplayObject();
Get a reference to the underlying display object for this view. For as2 this is a MovieClip, as3 an LzSprite and in dhtml it's a
getID3()
view.getID3();
Returns an object containing the media's id3 tag, assuming it's mp3 loaded with proxy == false;
Returns Type Description
  Object Object containind id3 tag data, if available.
getMouse()
view.getMouse(xory : String);
The position of the mouse relative to this view.
Parameter Name Type Description
xory String Which axis ("x" | "y") to return. If null returns both axes.
Returns Type Description
  Number The position of the mouse relative to this view along the specified axis. If both axes are requsted returns {x: Number, y: Number}.
getNextSelection()
view.getNextSelection();
Override to specify the next view to be focused
getPan()
view.getPan();
Get the pan of the attached resource
Returns Type Description
  Integer A number from -100 to 100 representing a pan level
getPrevSelection()
view.getPrevSelection();
Override to specify the previous view to be focused
getProxyURL()
view.getProxyURL(url);
Parameter Name Type Description
url    
getTotalTime()
view.getTotalTime();
Returns the total amount of time the resource would take to play.
Returns Type Description
  Number Seconds of media controlled by this view.
getVolume()
view.getVolume();
Get the volume of the attached resource
Returns Type Description
  Integer A number from 0 to 100 representing a volume level
init()
view.init();
Called right before the view is shown. See lz.node.init() for more.
isBehind()
view.isBehind(sibling);
Returns true if this view is behind a sibling view
Parameter Name Type Description
sibling    
isInFrontOf()
view.isInFrontOf(sibling);
Returns true if this view is in front of a sibling view
Parameter Name Type Description
sibling    
isMouseOver()
view.isMouseOver();
Returns true if the mouse is over this view
measureHeight()
view.measureHeight();
Reports the "natural" height of the contents of the view. That is, the height the view would have if it did not have an explicit height. (Note: this method is not supported in a constraint expression.)
measureWidth()
view.measureWidth();
Reports the "natural" width of the contents of the view. That is, the width the view would have if it did not have an explicit width. (Note: this method is not supported in a constraint expression.)
play()
view.play(f : Integer, rel : Boolean);
Start playing the attached resource. Note that a compiled resource that begins playing when it is attached (i.e. does not contain a 'stop' instruction in the first frame) will not send events and generally behave correctly unless it is told to play. Resources which are loaded via setSource don't have this issue.
Parameter Name Type Description
f Integer If defined, begin playing at the given frame. Otherwise, begin playing at the current frame.
rel Boolean If true, f is relative to the current frame. Otherwise f is relative to the beginning of the resource.
searchSubviews()
view.searchSubviews(prop : String, val : any);
Search all subviews for a named property. For now, returns when it finds the first one. This is a width first search.
Parameter Name Type Description
prop String named property
val any value for that property
Returns Type Description
  lz.view the first subview whose property prop is set to value val or null if none is found
seek()
view.seek(secs : Integer);
Skips forward or backward n seconds (depending on the sign of the argument). If playing, continue to play. If stopped, stay stopped
Parameter Name Type Description
secs Integer Number of seconds to skip forward or backward (if negative)
sendAAEvent()
view.sendAAEvent(childID : number, eventType : number, nonHTML : boolean);
Sends an event to the Microsoft Active Accessibility API. Microsoft Active Accessibility handles that event and sends the event to any active screen reader application, which in turn reports the change to the user. For example, when a user toggles a RadioButton instance, the RadioButton's Accessibility Implementation calls Accessibility.sendEvent() with the eventType EVENT_OBJECT_STATECHANGE/0x800a.
Parameter Name Type Description
childID number The child id of the accessibility interface element to which the event applies (for example, an individual list item in a list box). Use 0 to indicate that the event applies to the DisplayObject supplied in the source parameter.
eventType number A constant indicating the event type. Event names and values are a subset of the MSAA event constants.
nonHTML boolean A Boolean indication of whether or not the event is one of the standard event types that can be generated from an HTML form. When set to true, this parameter helps prevent some problems that may occur with screen readers that interperet Flash content as part of the HTML page. The default value is false.
sendBehind()
view.sendBehind(v : lz.view);
Puts this view directly behind one of its siblings. If this view is already in back of the target, but there are other views between this view and the target, that means this view will be moved in front of the intervening views.
Parameter Name Type Description
v lz.view The view this view should go behind. If the passed view is null or not a sibling, the method has no effect.
Returns Type Description
  Boolean Method returns true if the operation is successful.
sendInFrontOf()
view.sendInFrontOf(v : lz.view);
Puts this view directly in front of one of its siblings. If this view is already in front of the target, but there are other views between this view and the target, that means this view will be moved in back of the intervening views.
Parameter Name Type Description
v lz.view The view this view should go in front of. If the passed view is null or not a sibling, the method has no effect.
Returns Type Description
  Boolean Method returns true if the operation is successful.
sendToBack()
view.sendToBack();
This method makes this view the hindmost subview of this view's parent.
setAAActive()
view.setAAActive(s : Boolean);
[Caution] This method is deprecated
Use setAttribute('aaactive', ...) instead.
Activate/inactivate children for accessibility
Parameter Name Type Description
s Boolean If true, activate the current view and all of its children
setAADescription()
view.setAADescription(s : string);
[Caution] This method is deprecated
Use setAttribute('aadescription', ...) instead.
Set accessibility description
Parameter Name Type Description
s string Sets the accessibility description for this view
setAAName()
view.setAAName(s : string);
[Caution] This method is deprecated
Use setAttribute('aaname', ...) instead.
Set accessibility name
Parameter Name Type Description
s string Sets the accessibility name for this view
setAASilent()
view.setAASilent(s : string);
[Caution] This method is deprecated
Use setAttribute('aasilent', ...) instead.
Set accessibility silencing/unsilencing
Parameter Name Type Description
s string If true, this view is made silent to the screen reader. If false, it is active to the screen reader.
setAATabIndex()
view.setAATabIndex(s : number);
[Caution] This method is deprecated
Use setAttribute('aatabindex', ...) instead.
Set accessibility tab order
Parameter Name Type Description
s number The tab order index for this view. Must be a unique number.
setAccessible()
view.setAccessible(accessible : Boolean);
Parameter Name Type Description
accessible Boolean  
setAlign()
view.setAlign(align : String);
[Caution] This method is deprecated
Use setAttribute('align', ...) instead.
Sets the alignment for the view to the given value. The alignment is based on the size of this view as compared to the size of the view's immediate parent.
Parameter Name Type Description
align String The alignment for the view. This is one of "left", "center", and "right"
setAttributeRelative()
view.setAttributeRelative(prop : String, refView : lz.view);

Sets the named property of this view to the value that will cause the absolute value of the property in both views to be the same.

For example, a.setAttributeRelative('x', b) will cause the left edge of view a to be aligned with the left edge of view b on the canvas. This operation works for any two views on the canvas, regardless of their relative relationship.

See also lz.view.getAttributeRelative . this.setAttributeRelative(property, that) is the same as (but more efficient than) this.setAttribute(property, that.getAttributeRelative(property, this)).

Parameter Name Type Description
prop String the property to set: 'x', 'y', 'width', or 'height'
refView lz.view the view whose property is to be matched
setBGColor()
view.setBGColor(bgc : Integer);
[Caution] This method is deprecated
Use setAttribute('bgcolor', ...) instead.
Gives the view a bgcolor that is the same size as the view.
Parameter Name Type Description
bgc Integer The 0-FFFFFF number to be used for the new background color.
setClickable()
view.setClickable(amclickable : Boolean);
[Caution] This method is deprecated
Use setAttribute('clickable', ...) instead.
Makes a view clickable or not clickable.
Parameter Name Type Description
amclickable Boolean Boolean indicating the view's clickability
setColor()
view.setColor(c : Integer);
[Caution] This method is deprecated
Use setAttribute('tintcolor', ...) instead.
Sets the color of the view (the view's resource and any subviews) to the the color given. This will completely override any color information in the view or subview resources. Use the view attribute tintcolor to tint a view.
Parameter Name Type Description
c Integer A color in rgb format; for example, 0xff0000 is red.
setColorTransform() (as2, swf9)
view.setColorTransform(o : Object);
[Caution] This method is deprecated
Use setAttribute('colortransform', ...) instead.
color transforms everything contained in the view (except the background) by the transformation dictionary given in o. The dictionary has the following possible keys: o.ra: percentage alpha for red component (-100 to 100); o.rb: offset for red component (-255 to 255); o.ga: percentage alpha for green component (-100 to 100); o.gb: offset for green component (-255 to 255); o.ba: percentage alpha for blue component (-100 to 100); o.bb: offset for blue component (-255 to 255); o.aa: percentage overall alpha (-100 to 100); o.ab: offset for alpha component (-255 to 255);
Parameter Name Type Description
o Object A color transformation dictionary
setContextMenu()
view.setContextMenu(cmenu : lz.contextmenu);
[Caution] This method is deprecated
Use setAttribute('contextmenu', ...) instead.
Install menu items for the right-mouse-button
Parameter Name Type Description
cmenu lz.contextmenu lz.contextmenu to install on this view
setCursor()
view.setCursor(cursor : String);
[Caution] This method is deprecated
Use setAttribute('cursor', ...) instead.
Sets the cursor to the given resource when the mouse is over this view
Parameter Name Type Description
cursor String The name of the resource to use as a cursor when it is over this view. Or '' for default cursor.
setHeight()
view.setHeight(v : Number);
[Caution] This method is deprecated
Use setAttribute('height', ...) instead.
Sets the height of the view the given value. If the view is set to stretch its resource, the resource will be resized to the new value. If the value 'null' is given for the new height, then the height is unset, and the height of the view will be the size measured of its contents.
Parameter Name Type Description
v Number The new value for the height
setLayout()
view.setLayout(layoutobj : Object);
[Caution] This method is deprecated
Use setAttribute('layout', ...) instead.
this creates a specific child layout for this view. When called a second time the first layout will be replaced by the second.
Parameter Name Type Description
layoutobj Object A dictionary of attributes that describe the layout, where the class key specifies the class of the layout and the rest are passed as attributes for the layout. By default the class will be simplelayout if not given. For example: {'class': 'wrappinglayout', axis: 'x', spacing: 20} To remove the previously set layout, use {'class': 'none'} (Note that you must use 'class' as the key, because class is a keyword reserved for future use.)
setOpacity()
view.setOpacity(v : Number);
[Caution] This method is deprecated
Use setAttribute('opacity', ...) instead.
Sets the opacity for the view. The opacity is a number between 0.0 (transparent) and 1.0 (opaque).
Parameter Name Type Description
v Number The new value for the opacity
setPan()
view.setPan(p : Integer);
Set the pan of the attached resource
Parameter Name Type Description
p Integer A number from -100 to 100 representing a pan level
setPlay()
view.setPlay(b : Boolean);
[Caution] This method is deprecated
Use setAttribute('play', ...) instead.
Start or stop playing the attached resource.
Parameter Name Type Description
b Boolean If true, starts playing, otherwise stops
setProxyPolicy()
view.setProxyPolicy(f : Function);
Sets a proxy policy function on a per-view basis.
Parameter Name Type Description
f Function A function that takes a URL as a string and returns true or false, meaning that the request should be proxied by the LPS server or made directly to the URL.
setProxyURL()
view.setProxyURL(f : Object);
[Caution] This method is deprecated
Use setAttribute('proxyurl', ...) instead.
Sets a proxy policy function on a per-view basis.
Parameter Name Type Description
f Object If a string, use as a URL to the proxy server. If a function, it should take a URL of a resource, and return the URL of the proxy server to use to load that resource.
setResource()
view.setResource(v : String);
[Caution] This method is deprecated
Use setAttribute('resource', ...) instead.
This method associates a view with a named library element. If the view's visible property is true, the resource will be displayed when it is attached
Parameter Name Type Description
v String a string naming the id of the resource to attach
setResourceNumber()
view.setResourceNumber(n : Integer);
[Caution] This method is deprecated
Use setAttribute('frame', ...) instead.
For resources which have more than one frame, this function sets the view to display the numbered resource. For Flash assets, resource numbers correspond to movieclip frames.
Parameter Name Type Description
n Integer the number of the resource to show
setRotation()
view.setRotation(v : Number);
[Caution] This method is deprecated
Use setAttribute('rotation', ...) instead.
Sets the rotation for the view to the given value.
Parameter Name Type Description
v Number The new value for rotation.
setShowHandCursor()
view.setShowHandCursor(s : Boolean);
[Caution] This method is deprecated
Use setAttribute('showhandcursor', ...) instead.
Shows or hides the hand cursor for this view.
Parameter Name Type Description
s Boolean true shows the hand cursor for this view, false hides it
setSource()
view.setSource(source : String, cache : String, headers : String, filetype : String);
This function allows the view to load its media from an URL at runtime. Resources loaded with setSource will replace compiled resources when the request is made.
Parameter Name Type Description
source String The URL from which to load the resource for this view.
cache String If set, controls caching behavior. Choices are none , clientonly , serveronly , both (the default for Flash). DHTML applications cache media on the client only. DHTML supports the memorycache option which enables in-memory resource caching. This enhances performance when swapping resources quickly, and is used internally for multi-frame resources. Media loaded with memorycache will remain in memory until the page is unloaded or unload() is called.
headers String Headers to send with the request, if any.
filetype String Filetype, e.g. 'mp3' or 'jpg'. If not specified, it will be derived from the URL.
setValign()
view.setValign(valign : String);
[Caution] This method is deprecated
Use setAttribute('valign', ...) instead.
Sets the vertical alignment for the view to the given value. The alignment is based on the height of this view as compared to the height of the view's immediateparent.
Parameter Name Type Description
valign String The vertical alignment for the view. This is one of "top", "middle", and "bottom"
setVisibility()
view.setVisibility(amVisible : String);
[Caution] This method is deprecated
Use setAttribute('visibility', ...) instead.
This method sets the visibility attribute of the view and also disables or re-enables any click region associated with the view. The argument is a string which can be "visible", "hidden", or "collapse". Setting the value to "collapse" will cause the view to become hidden when it has a datapath and there are no matching data nodes in its dataset.
Parameter Name Type Description
amVisible String visibility of view
setVisible()
view.setVisible(v : Boolean|Null);
[Caution] This method is deprecated
Use setAttribute('visible', ...) instead.
This method sets the visible attribute of the view and also disables or re-enables any click region associated with the view.
Parameter Name Type Description
v Boolean|Null Controls the visibility of a view. `true` makes the view visible, `false` makes the view hidden, `null` will make the view visible only if it has a data binding.
setVolume()
view.setVolume(v : Integer);
Set the volume of the attached resource
Parameter Name Type Description
v Integer A number from 0 to 100 representing a volume level
setWidth()
view.setWidth(v : Number);
[Caution] This method is deprecated
Use setAttribute('width', ...) instead.
Sets the width of the view. If the view is set to stretch its resource, the resource will be resized to the new value. If the value 'null' is given for the new width, then the width is unset, and the width of the view will be the size of its contents.
Parameter Name Type Description
v Number The new value for the width
setX()
view.setX(v : Number);
[Caution] This method is deprecated
Use setAttribute('x', ...) instead.
Sets the x position of the view to the given value.
Parameter Name Type Description
v Number The new value for x.
setXOffset()
view.setXOffset(o : Integer);
[Caution] This method is deprecated
Use setAttribute('xoffset', ...) instead.
Sets the x offset
Parameter Name Type Description
o Integer The x offset
setY()
view.setY(v : Number);
[Caution] This method is deprecated
Use setAttribute('y', ...) instead.
Sets the y position for the view to the given value.
Parameter Name Type Description
v Number The new value for y.
setYOffset()
view.setYOffset(o : Integer);
[Caution] This method is deprecated
Use setAttribute('yoffset', ...) instead.
Sets the Y offset
Parameter Name Type Description
o Integer The y offset
shouldYieldFocus()
view.shouldYieldFocus();
Determine whether a view should give up focus. Override this method to specify your own policy.
stop()
view.stop(f : Integer, rel : Boolean);
Stop playing the attached resource
Parameter Name Type Description
f Integer If defined, stop playing at the given frame. Otherwise, stop at the current frame.
rel Boolean If true, f is relative to the current frame. Otherwise it is relative to the start position of the resource.
stretchResource()
view.stretchResource(v : String);
[Caution] This method is deprecated
Use setAttribute('stretches', ...) instead.
Sets the view so that it stretches its resource in the given axis so that the resource is the same size as the view. The has the effect of distorting the coordinate system for all children of this view, so use this method with care.
Parameter Name Type Description
v String Set the resource to stretch only in the given axis ("width" or "height") or in both axes ("both").
unload()
view.unload();
Unloads media loaded with setSource or the source= attribute.
updateResourceSize()
view.updateResourceSize();
Since a view does not re-measure the size of its resource once that resource has loaded, this method is provided to force the view to update its size, taking into account the current size of its resource.

Methods inherited from <node>

animate, applyConstraint, applyConstraintMethod, applyData, childOf, completeInstantiation, construct, createChildren, dataBindAttribute, destroy, determinePlacement, getOption, getUID, init, lookupSourceLocator, releaseConstraint, releaseConstraintMethod, searchImmediateSubnodes, searchSubnodes, setData, setDatapath, setOption, setSelected, updateData

Methods inherited from lz.Eventable

destroy, setAttribute

Class Methods

addProxyPolicy()
lz.view.addProxyPolicy(f : Function);
Adds a function which can decide how the media at a given URL should be loaded
Parameter Name Type Description
f Function A function that takes a URL as a string and returns one of true, false, or null meaning respectively that the request should be proxied by the LPS server; made directly to the URL; or should be passed to the next policy function in the list. The default policy function returns the value of canvas.proxied
removeProxyPolicy()
lz.view.removeProxyPolicy(f : Function);
Removes a proxy policy function that has been added using lz.view.addProxyPolicy
Parameter Name Type Description
f Function The function to remove from the policy list
Returns Type Description
  Boolean Returns true if the function was found and removed, false if not

Events

Name Description
onaddsubview Event called when this view adds a subview
onbackgroundrepeat event for changes to view's backgroundrepeat property
onblur The onblur event is sent when an element loses focus either by the pointing device or by tabbing navigation.
onclick The onclick event is sent when the pointing device button is clicked over an element.
onclickable Event for changes to view's clickable property
onclip The onclip event is sent when the clip attribute of a view is changed
oncontext Sent when the drawing context is ready to use, which can take some time in IE DHTML.
oncornerradius Sent when cornerradius changes
ondblclick The ondblclick event is sent when the pointing device button is double clicked over an element.
onerror Sent when there is an error loading the view's resource. The argument sent with the event is an error string.
onfocus The onfocus event is sent when an element receives focus either by the pointing device or by tabbing navigation.
onframe Sent onidle while view is playing its resource
onframesloadratio Sends a percentage (0-1) reflecting the number of frames downloaded.
onheight Event for changes to view's height property
onkeydown The onkeydown event is sent when this view has the focus and a key is pressed down. Multiple key down events are sent for a key that is held down. If you want the script executed only once, use onkeyup. This event is sent with the keycode for the key that is down.
onkeyup The onkeyup event is sent when this view has the focus and a key is released. This event is sent with the keycode for the key that went up.
onlastframe Sent when the view sets its frame (resource number) to the last frame. This can be used to find out when a streaming media clip is done playing.
onload Send when the view finishes loading media.
onloadratio Sends a percentage (0-1) reflecting the amount of a media file that's been downloaded.
onmousedown The onmousedown event is sent when the pointing device button is pressed over an element.
onmousedragin The onmousedragin event is sent when the pointing device button has moved off the element and back on again while the button is down.
onmousedragout The onmousedragout event is sent when the pointing device is moved off the element while the button is down. down.
onmouseout The onmouseout event is sent when the pointing device is moved so that is is no longer over an element.
onmouseover The onmouseover event is sent when the pointing device is moved onto an element.
onmousetrackout Sent when the mouse leaves the visible area of a view that previously sent an 'ontrackover' event.
onmousetrackover Sent when the mouse is over a view that is registered to an active track group.
onmousetrackup Sent when the mouse button is released over a view that is registered to an active track group.
onmouseup The onmouseup event is sent when the pointing device button is released over an element.
onmouseupoutside The onmouseup event is sent when the pointing device button is released outside the element it went down on.
onopacity Sent when a view changes its opacity
onplay Sent when a view begins playing its resource
onremovesubview Event called when this view removes a subview
onshadowangle Sent when shadowangle changes
onshadowblurradius Sent when shadowblurradius changes
onshadowcolor Sent when shadowcolor changes
onshadowdistance Sent when shadowdistance changes
onstop Sent when a view's resource that is capable of playing is stopped. This is only called if stop is called directly; when a resource hits its last frame, the lz.view event onlastframe is called.
ontimeout Sent when the request to load media for the view times out
onvisible Sent when the view changes visibility (true/false)
onwidth event for changes to view's width property
onx event for changes to view's x property
ony event for changes to view's y property

Events inherited from <node>

onconstruct, ondata, oninit

Events inherited from lz.Eventable

ondestroy

Copyright © 2002-2010 Laszlo Systems, Inc. All Rights Reserved. Unauthorized use, duplication or distribution is strictly prohibited. This is the proprietary information of Laszlo Systems, Inc. Use is subject to license terms.

Prev  Up  Next
<canvas>  Home  Part III. Components Reference