PowerUI.MarqueeTag Class Reference

Detailed Description

Represents a non-standard marquee tag.

Inheritance diagram for PowerUI.MarqueeTag:

Public Member Functions
void	Start ()
	Call this to begin a marquee. More...
void	Stop ()
	Call this to stop a scrolling marquee. 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 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 void	OnChildrenLoaded ()
	Called when the elements kids are fully loaded. 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...
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...
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...
virtual 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...

Public Attributes
bool	Active
	True when this marquee is active. More...
int	Loop =-1
	The amount of times this will loop. More...
int	ScrollAmount =6
	The amount of pixels a scroll will cause. More...
int	ScrollDelay =85
	The time in milliseconds between scrolls. More...
MarqueeBehaviour	Behaviour =MarqueeBehaviour.Scroll
	How this marquee scrolls. More...
MarqueeDirection	Direction =MarqueeDirection.Left
	The direction of the marquee. 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	OnTick ()
void	Bounced ()
	Called when the marquee bounces the content. More...
void	Wrapped ()
	Called when the marquee wraps. More...
void	ApplyBehaviour (string behaviour)

Private Attributes
UITimer	Timer
	The underlying timer which causes the scrolling. More...

Member Function Documentation

void PowerUI.MarqueeTag.ApplyBehaviour ( string  behaviour)

inlineprivate

void PowerUI.MarqueeTag.Bounced ( )

inlineprivate

Called when the marquee bounces the content.

override Wrench.TagHandler PowerUI.MarqueeTag.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.MarqueeTag.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.

override bool PowerUI.MarqueeTag.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.MarqueeTag.OnChildrenLoaded ( )

inlinevirtual

Called when the elements kids are fully loaded.

Reimplemented from PowerUI.HtmlTagHandler.

void PowerUI.MarqueeTag.OnTick ( )

inlineprivate

void PowerUI.MarqueeTag.Start ( )

inline

Call this to begin a marquee.

void PowerUI.MarqueeTag.Stop ( )

inline

Call this to stop a scrolling marquee.

void PowerUI.MarqueeTag.Wrapped ( )

inlineprivate

Called when the marquee wraps.

Member Data Documentation

bool PowerUI.MarqueeTag.Active

True when this marquee is active.

MarqueeBehaviour PowerUI.MarqueeTag.Behaviour =MarqueeBehaviour.Scroll

How this marquee scrolls.

MarqueeDirection PowerUI.MarqueeTag.Direction =MarqueeDirection.Left

The direction of the marquee.

int PowerUI.MarqueeTag.Loop =-1

The amount of times this will loop.

int PowerUI.MarqueeTag.ScrollAmount =6

The amount of pixels a scroll will cause.

int PowerUI.MarqueeTag.ScrollDelay =85

The time in milliseconds between scrolls.

UITimer PowerUI.MarqueeTag.Timer

private

The underlying timer which causes the scrolling.