Detailed Description

Handles script tags. They should have type="text/nitro" to be handled by PowerUI; Javascript is ignored. The src="" attribute is also supported if you wish to reuse script by loading it externally.

Inheritance diagram for PowerUI.ScriptTag:
PowerUI.HtmlTagHandler Wrench.TagHandler

Public Member Functions

override string[] GetTags ()
 Returns all tags that are handled by this handler, e.g. "div" or "span". Usually there will be just one in the set but some tags may wish to have more. More...
 
override Wrench.TagHandler GetInstance ()
 Makes a new instance of this tag handler. A global instance is made of this handler so this is used to generate a new instance in an efficient way. More...
 
override void OnParseContent (MLLexer lexer)
 Called when the parser is reading the content of this tag for custom reading, e.g. a script/style tag. Non-self closing tags only. Anything that's not read by this method is assumed to be a child element. More...
 
override bool OnAttributeChange (string property)
 Called when an attribute of the element was changed. Returns true if the method handled the change to prevent unnecessary checks. More...
 
override void OnTagLoaded ()
 Called when the tag is instanced and the element plus its attributes and kids have been fully parsed. More...
 
- Public Member Functions inherited from PowerUI.HtmlTagHandler
void RequestLayout ()
 Requests the renderer handling this element to layout next update. More...
 
virtual bool Junk ()
 Tells the parser to not include this element in the DOM. More...
 
virtual void OnResetAllVariables ()
 Called when all variable () values must have their content reloaded. More...
 
virtual void OnResetVariable (string name)
 Called when the named variable variable () values must have its content reloaded. More...
 
virtual void OnRenderPass ()
 Called during a layout event on only the focused element. More...
 
virtual void HeightChanged ()
 Called when the fixed height of this element changes. More...
 
virtual void WidthChanged ()
 Called when the width of this element changes. More...
 
virtual void OnLayout ()
 Called during a layout event on all elements. More...
 
virtual void OnFocus ()
 Called when this element comes into focus. More...
 
virtual void OnBlur ()
 Called when this element becomes unfocused. More...
 
virtual void OnLoaded (string objectLoaded)
 Called when this elements content has been loaded. Used by e.g. iframe or img. More...
 
virtual void OnKeyPress (UIEvent pressEvent)
 Called on the focused element when a key is pressed or released. More...
 
virtual void OnMouseMove (UIEvent moveEvent)
 Called on the focused element when the mouse is moved. More...
 
virtual bool OnClick (UIEvent clickEvent)
 Called when the element is clicked (or the mouse is released over it). More...
 
virtual KeyboardMode OnShowMobileKeyboard ()
 Called when PowerUI attempts to display the mobile keyboard (only called on mobile platforms). More...
 
virtual void OnChildrenLoaded ()
 Called when the elements kids are fully loaded. More...
 
- Public Member Functions inherited from Wrench.TagHandler
virtual bool SelfClosing ()
 Returns true if this tag has no kids and closes itself. For example <input type='text' />. Note that this method exists to make that final slash essentially optional. More...
 

Public Attributes

bool Dump
 Dump is true if this script tag content should be completely ignored. More...
 
string Src
 The external path to this script. More...
 
bool Loaded
 True if the tag is fully loaded; false if it's still being parsed. More...
 
int CodeIndex =-1
 Code index is used to place script into the code buffer so it's placed correctly relative to all other code. This is required if this script takes longer to load than script after it. More...
 
- Public Attributes inherited from PowerUI.HtmlTagHandler
bool IsIsolated
 True if this element is isolated from style changes by its parent (e.g. used by iframes). More...
 
Element Element
 The element this tag handler is attached to. More...
 
bool IgnoreClick
 True if the element should ignore all clicks. More...
 
bool IsFocusable
 True if this tag is focusable. More...
 
bool IgnoreSelfClick
 Set this to true if this element should ignore clicks on itself, but not its kids (e.g. html or body). More...
 
- Public Attributes inherited from Wrench.TagHandler
int Priority
 If you define a tag handler with tags which already exist, this priority allows your tag to override the existing one optionally. All system tags have a priority of zero. More...
 
string TagExtension
 This is applied to every derivative of this tag handler. This enables tags to be grouped by file they are handling. e.g. "ui" extension and tag name "div" would become "ui-div" internally. More...
 

Private Member Functions

void LoadContent ()
 Sends a request off to get the content of this tag if it's external (i.e. has an src attribute). More...
 
void OnTextReady (TextPackage package)
 The callback for the request to get the external script. More...
 
bool AtEnd (MLLexer lexer)
 Checks if the given lexer has reached the end of the inline script content. More...
 

Member Function Documentation

bool PowerUI.ScriptTag.AtEnd ( MLLexer  lexer)
inlineprivate

Checks if the given lexer has reached the end of the inline script content.

Parameters
lexerThe lexer to check if it's reached the </script> tag.
Returns
True if the lexer has reached the end script tag; false otherwise.
override Wrench.TagHandler PowerUI.ScriptTag.GetInstance ( )
inlinevirtual

Makes a new instance of this tag handler. A global instance is made of this handler so this is used to generate a new instance in an efficient way.

Reimplemented from Wrench.TagHandler.

override string [] PowerUI.ScriptTag.GetTags ( )
inlinevirtual

Returns all tags that are handled by this handler, e.g. "div" or "span". Usually there will be just one in the set but some tags may wish to have more.

Reimplemented from Wrench.TagHandler.

void PowerUI.ScriptTag.LoadContent ( )
inlineprivate

Sends a request off to get the content of this tag if it's external (i.e. has an src attribute).

override bool PowerUI.ScriptTag.OnAttributeChange ( string  property)
inlinevirtual

Called when an attribute of the element was changed. Returns true if the method handled the change to prevent unnecessary checks.

Reimplemented from PowerUI.HtmlTagHandler.

override void PowerUI.ScriptTag.OnParseContent ( MLLexer  lexer)
inlinevirtual

Called when the parser is reading the content of this tag for custom reading, e.g. a script/style tag. Non-self closing tags only. Anything that's not read by this method is assumed to be a child element.

Parameters
lexerThe lexer to read the content from.

Reimplemented from Wrench.TagHandler.

override void PowerUI.ScriptTag.OnTagLoaded ( )
inlinevirtual

Called when the tag is instanced and the element plus its attributes and kids have been fully parsed.

Reimplemented from Wrench.TagHandler.

void PowerUI.ScriptTag.OnTextReady ( TextPackage  package)
inlineprivate

The callback for the request to get the external script.

Parameters
packageThe text package containing the script if the request was ok.

Member Data Documentation

int PowerUI.ScriptTag.CodeIndex =-1

Code index is used to place script into the code buffer so it's placed correctly relative to all other code. This is required if this script takes longer to load than script after it.

bool PowerUI.ScriptTag.Dump

Dump is true if this script tag content should be completely ignored.

bool PowerUI.ScriptTag.Loaded

True if the tag is fully loaded; false if it's still being parsed.

string PowerUI.ScriptTag.Src

The external path to this script.