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().
|
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.
execute
Void execute(<Event> event)
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().
Documentation generated by
JSDoc on Wed Nov 1 15:37:30 2006