Category:Common Methods

From Lianjapedia
Jump to: navigation, search

Each of the Lianja base UI classes has some common methods as well as some that are specific to the UI Class itself. The following table summarizes the common methods. Note: method names should be referred to in lowercase in case-sensitive scripting languages.

Method Arguments Description
AddClass name as Character Styles the object with a space separated list of built-in CSS classes
Attr name as Character[, value as Expr] Styles the object with a CSS element if value is specified. If no value is specified returns the current value
AddProperty name as Character, value as Expr Adds a property to the object
AdjustSize None Changes the size of the object to fit its contents
Animate x as Numeric, y as Numeric, width as Numeric, height as Numeric, x2 as Numeric, y2 as Numeric, width2 as Numeric, height2 as Numeric, duration as Numeric Slides the object from position x,y with a size of width,height to the position x2,y2 with a size of width2,height2. Duration is the time taken in milliseconds
AutoFit None Changes the size of the object to fit its contents
BindEvent sourceobject as Object, eventname as Character, handlerobject as Object, procname as Character, flags as Numeric Defines a delegate procedure of a handler object to handle an event for an object
BindEvents sourceobject as Object, eventname as Character, handlerobject as Object, procname as Character, flags as Numeric Defines a delegate procedure of a handler object to handle an event for an object
Drag action as Numeric 0=Cancel, 1=Begin, 2=End
FadeIn duration as Numeric Fades the object out (completely transparent). Duration is the time taken in milliseconds
FadeOut duration as Numeric Fades the object in (completely opaque). Duration is the time taken in milliseconds
Hide None Makes the object invisible
Lower None Lowers the object to the bottom of the parent widget's stack
Move x as Numeric, y as Numeric, width as Numeric, height as Numeric Changes the position or size of the object
Raise None Raises the object to the top of the parent widget's stack
Redraw None Forces a redraw of the object applying any CSS associated with the object
Refresh None Forces all data bound UI controls and their children to be refreshed
RemoveClass classname as Character Removes the CSS class styling
RemoveItem name as Character Removes a named item associated with this object
RemoveProperty name as Character Removes a property from the object
Resize width as Numeric, height as Numeric Changes the size of the object
SetFocus None Gives focus to the object
SetItem Name as character, value as Expression Associates a named item with the object
GetItem Name as character Returns the value of a named item associated with the object
Show None Makes the object visible
ShowInfoTip Text as character Pops up and informational tooltip above/below the object
SlideDown duration as Numeric Slides the object in from top to bottom. Duration is the time taken in milliseconds
SlideLeft duration as Numeric Slides the object left from the width of the object returning to its original position. Duration is the time taken in milliseconds
SlideRight duration as Numeric Slides the object right to the width of the object. Duration is the time taken in milliseconds
SlideUp duration as Numeric Slides the object out from bottom to top. Duration is the time taken in milliseconds
UnbindEvent sourceobject as Object, eventname as Character, handlerobject as Object, procname as Character, flags as Numeric Resets event binding for the specified event
UnbindEvents sourceobject as Object, eventname as Character, handlerobject as Object, procname as Character, flags as Numeric Resets event binding for the specified event
ZoomIn duration as Numeric Slides the object from bottom right to top left returning to its original position. Duration is the time taken in milliseconds
ZoomOut duration as Numeric Slides the object out to bottom right. Duration is the time taken in milliseconds