Detailed Description

Handles textarea tags.

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

Public Member Functions

 TextareaTag ()
 
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 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 KeyboardMode OnShowMobileKeyboard ()
 Called when PowerUI attempts to display the mobile keyboard (only called on mobile platforms). 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...
 
void SetValue (string value)
 Sets the value of this textarea. More...
 
void SetValue (string value, bool html)
 Sets the value of this textarea, optionally as a html string. More...
 
override void OnKeyPress (UIEvent pressEvent)
 Called on the focused element when a key is pressed or released. More...
 
void MoveCursor (int index)
 For text and password inputs, this relocates the cursor to the given index. More...
 
void MoveCursor (int index, bool immediate)
 For text and password inputs, this relocates the cursor to the given index. More...
 
override void OnRenderPass ()
 Called immediately after the text pass on the focused element. More...
 
override void OnFocus ()
 Called when the element is focused. More...
 
override void OnBlur ()
 Called when the element is unfocused/blurred. More...
 
override bool OnClick (UIEvent clickEvent)
 Called when the element is clicked (or the mouse is released over it). 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 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 OnLoaded (string objectLoaded)
 Called when this elements content has been loaded. Used by e.g. iframe or img. More...
 
virtual void OnMouseMove (UIEvent moveEvent)
 Called on the focused element when the mouse is moved. 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...
 
virtual void OnTagLoaded ()
 Called when the tag is instanced and the element plus its attributes and kids have been fully parsed. More...
 

Public Attributes

string Value
 The value text for this input. More...
 
Element Cursor
 This is the cursor element. More...
 
int CursorIndex
 The current location of the cursor. More...
 
bool LocateCursor
 True if the cursor should be located after the next update. More...
 
int MaxLength =int.MaxValue
 The maximum length of text in this box. 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 LocateCursorNow ()
 Positions the cursor immediately. More...
 
bool AtEnd (MLLexer lexer)
 Checks if the given lexer has reached the end of the inline textarea content. More...
 

Constructor & Destructor Documentation

PowerUI.TextareaTag.TextareaTag ( )
inline

Member Function Documentation

bool PowerUI.TextareaTag.AtEnd ( MLLexer  lexer)
inlineprivate

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

Parameters
lexerThe lexer to check if it's reached the </textarea> tag.
Returns
True if the lexer has reached the end textarea tag; false otherwise.
override Wrench.TagHandler PowerUI.TextareaTag.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.TextareaTag.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.TextareaTag.LocateCursorNow ( )
inlineprivate

Positions the cursor immediately.

void PowerUI.TextareaTag.MoveCursor ( int  index)
inline

For text and password inputs, this relocates the cursor to the given index.

Parameters
indexThe character index to move the cursor to, starting at 0.
void PowerUI.TextareaTag.MoveCursor ( int  index,
bool  immediate 
)
inline

For text and password inputs, this relocates the cursor to the given index.

Parameters
indexThe character index to move the cursor to, starting at 0.
immediateTrue if the cursor should be moved right now.
override bool PowerUI.TextareaTag.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.TextareaTag.OnBlur ( )
inlinevirtual

Called when the element is unfocused/blurred.

Reimplemented from PowerUI.HtmlTagHandler.

override bool PowerUI.TextareaTag.OnClick ( UIEvent  clickEvent)
inlinevirtual

Called when the element is clicked (or the mouse is released over it).

Parameters
clickEventThe UIEvent describing the click.

Reimplemented from PowerUI.HtmlTagHandler.

override void PowerUI.TextareaTag.OnFocus ( )
inlinevirtual

Called when the element is focused.

Reimplemented from PowerUI.HtmlTagHandler.

override void PowerUI.TextareaTag.OnKeyPress ( UIEvent  pressEvent)
inlinevirtual

Called on the focused element when a key is pressed or released.

Parameters
pressEventThe UIEvent describing the press; e.g. which key.

Reimplemented from PowerUI.HtmlTagHandler.

override void PowerUI.TextareaTag.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.TextareaTag.OnRenderPass ( )
inlinevirtual

Called immediately after the text pass on the focused element.

Reimplemented from PowerUI.HtmlTagHandler.

override KeyboardMode PowerUI.TextareaTag.OnShowMobileKeyboard ( )
inlinevirtual

Called when PowerUI attempts to display the mobile keyboard (only called on mobile platforms).

Returns
A KeyboardType if this element wants the keyboard to show up (KeyboardType.None otherwise).

Reimplemented from PowerUI.HtmlTagHandler.

void PowerUI.TextareaTag.SetValue ( string  value)
inline

Sets the value of this textarea.

Parameters
valueThe value to set.
void PowerUI.TextareaTag.SetValue ( string  value,
bool  html 
)
inline

Sets the value of this textarea, optionally as a html string.

Parameters
valueThe value to set.
htmlTrue if the value can safely contain html.

Member Data Documentation

Element PowerUI.TextareaTag.Cursor

This is the cursor element.

int PowerUI.TextareaTag.CursorIndex

The current location of the cursor.

bool PowerUI.TextareaTag.LocateCursor

True if the cursor should be located after the next update.

int PowerUI.TextareaTag.MaxLength =int.MaxValue

The maximum length of text in this box.

string PowerUI.TextareaTag.Value

The value text for this input.