mozdev.org

• Thursday December 4th 2008
• Batteries not included.

Skip to Content

Mozile (xhtml editing in your browser)    

resources:	Home Use FAQ Contribute Mailing List Plan Source Code Bugs

Overview  File   Class  Tree  Index  Help
PREV CLASS  NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Class MozileWrapCommand

Object
   |
   +--MozileComponent
         |
         +--MozileCommand
               |
               +--MozileWrapCommand

Direct Known Subclasses:

MozileStyleCommand

---

class MozileWrapCommand

extends MozileCommand

Defined in XHTMLBasic.js

---

Constructor Summary

MozileWrapCommand (<String> configString)             Mozile Wrap Command Object - Wraps the current selection with an element.

 

Method Summary
Void	execute(<Event> event)            Executes the command.
XULElement	getMenuitem()
String	getMode()            Gets the mode for the module.
String	getTag()            Gets the tag for the module.
Boolean	isActive()            Mozile Wrap Command - Is Active - Checks to see if the current node has a parent which matches this.getTag().

 

Methods inherited from class MozileCommand

getId, isUndoable, getButton, isAvailable, show, hide, update

   

Methods inherited from class MozileComponent

toString, getName, getConfigString, getOptions, getOption, setOption, _cleanOption

 

Constructor Detail

MozileWrapCommand

MozileWrapCommand(<String> configString)

Mozile Wrap Command Object - Wraps the current selection with an element. This command has three modes: inline, toggle, and block. Inline means that the current selection is wraped in a non-block element. Toggle acts like inline, except that if the current selection is already inside the given element type then the selection "unwrapped" so that it is no longer within that element. Block means that the wrapper element is a block.

Configuration String Requirements: "mode=[inline|toggle|block], tag=[tagName]", for example "mode=toggle, tag=b".

Parameters:
configString - A properly formatted configuration string.

---

Method Detail

execute

Void execute(<Event> event)

Executes the command.

Parameters:
event - The event object which triggered the command.

---

getMenuitem

XULElement getMenuitem()

---

getMode

String getMode()

Gets the mode for the module. Throws an error if none exists.

---

getTag

String getTag()

Gets the tag for the module. Throws an error if none exists.

---

isActive

Boolean isActive()

Mozile Wrap Command - Is Active - Checks to see if the current node has a parent which matches this.getTag().

---

Overview  File   Class  Tree  Index  Help
PREV CLASS  NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---