Packageverlocity.components
Classpublic final class verUI
InheritanceverUI Inheritance Component Inheritance Singleton Inheritance Object

Handles all the UI elements. Buttons, text, scroll bars, etc. Has built in methods for key navigation with mouse-based buttons.


Public Properties
 PropertyDefined By
 InheritedclassName : Object
[read-only] Returns the class name of the component for dictionary registration.
Component
Protected Properties
 PropertyDefined By
 Inheritedstage : Stage
Component
Public Methods
 MethodDefined By
  
verUI(sStage:Stage)
Constructor of the component.
verUI
  
_Destruct():void
[override] Destructor of the component.
verUI
 Inherited
_IsNotUpdating():Boolean
Returns if the component is not updating (paused).
Component
 Inherited
_IsValid():Boolean
Returns if this singleton is active/valid.
Singleton
 Inherited
_SetUpdating(bUpdating:Boolean):void
Pauses/resumes the component updating, if it's pausable.
Component
 Inherited
_UpdateComponent():void
Updates the component, if possible.
Component
  
CreateButton(sName:String, sText:String, tfTextFormat:TextFormat, iPosX:int = 0, iPosY:int = 0, cButton:Class = null, fFunction:Function = null, fCondition:Function = null):Button
Creates a button.
verUI
  
CreateText(sName:String, sText:String, tfTextFormat:TextFormat, sLayer:String, iPosX:int = 0, iPosY:int = 0):Text
Creates a text element.
verUI
  
EnterHighlightedButton():void
Activates UI button (used for key input)
verUI
  
Get(sName:String):UIElement
Gets and returns a UI element
verUI
  
HighlightNextButton():void
Selects the next UI button (used for key input)
verUI
  
HighlightPreviousButton():void
Selects the previous UI button (used for key input)
verUI
  
RegisterButton(button:Button):void
Stores the button for key input
verUI
  
Remove(sName:String):void
Removes a UI element
verUI
  
RemoveAll():void
Removes all UI elements
verUI
  
SetAsCurrentHighlightedButton(button:Button):void
Sets the current button to be highlighted
verUI
  
UnHighlightCurrentButton():void
Removes the current button highlight
verUI
  
UnregisterButton(button:Button):void
Removes button from the key input list
verUI
Protected Methods
 MethodDefined By
  
_Concommands():void
[override] Concommands of the component.
verUI
 Inherited
_Update():void
Called each engine tick (verEngine), if the component updates
Component
Constructor Detail
verUI()Constructor
public function verUI(sStage:Stage)

Constructor of the component.

Parameters
sStage:Stage
Method Detail
_Concommands()method
override protected function _Concommands():void

Concommands of the component.

_Destruct()method 
override public function _Destruct():void

Destructor of the component.

CreateButton()method 
public final function CreateButton(sName:String, sText:String, tfTextFormat:TextFormat, iPosX:int = 0, iPosY:int = 0, cButton:Class = null, fFunction:Function = null, fCondition:Function = null):Button

Creates a button.

Parameters

sName:String — The name of the button
 
sText:String — The text displayed on the button
 
tfTextFormat:TextFormat — The text format of the button text
 
iPosX:int (default = 0) — The X position to place the button
 
iPosY:int (default = 0) — The Y position to place the button
 
cButton:Class (default = null) — The button class (style of the button)
 
fFunction:Function (default = null) — The function the button preforms
 
fCondition:Function (default = null) — The conditional function that toggles the button off/on

Returns
Button —
CreateText()method 
public final function CreateText(sName:String, sText:String, tfTextFormat:TextFormat, sLayer:String, iPosX:int = 0, iPosY:int = 0):Text

Creates a text element.

Parameters

sName:String — The name of the text
 
sText:String — The text to display
 
tfTextFormat:TextFormat — The text format of the text
 
sLayer:String — The layer to put this on
 
iPosX:int (default = 0) — The X position of the text
 
iPosY:int (default = 0) — The Y position of the text

Returns
Text —
EnterHighlightedButton()method 
public final function EnterHighlightedButton():void

Activates UI button (used for key input)

Get()method 
public final function Get(sName:String):UIElement

Gets and returns a UI element

Parameters

sName:String

Returns
UIElement —
HighlightNextButton()method 
public final function HighlightNextButton():void

Selects the next UI button (used for key input)

HighlightPreviousButton()method 
public final function HighlightPreviousButton():void

Selects the previous UI button (used for key input)

RegisterButton()method 
public final function RegisterButton(button:Button):void

Stores the button for key input

Parameters

button:Button — The button

Remove()method 
public final function Remove(sName:String):void

Removes a UI element

Parameters

sName:String

RemoveAll()method 
public final function RemoveAll():void

Removes all UI elements

SetAsCurrentHighlightedButton()method 
public final function SetAsCurrentHighlightedButton(button:Button):void

Sets the current button to be highlighted

Parameters

button:Button

UnHighlightCurrentButton()method 
public final function UnHighlightCurrentButton():void

Removes the current button highlight

UnregisterButton()method 
public final function UnregisterButton(button:Button):void

Removes button from the key input list

Parameters

button:Button — The button





Wed Feb 29 2012, 07:04 PM -08:00