org.fujion.codemirror

Class CodeMirrorXML

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.component.BaseInputComponent<String>

org.fujion.codemirror.CodeMirrorBase<CodeMirrorXML.XMLOptions>

org.fujion.codemirror.CodeMirrorXML

All Implemented Interfaces:

org.fujion.ancillary.IDisable, org.fujion.ancillary.IElementIdentifier, org.fujion.client.IClientTransform, org.fujion.common.IAttributeMap<String,Object>

@Component(tag="codemirror_xml",
           widgetModule="fujion-codemirror-xml",
           widgetClass="CodeMirrorXML",
           parentTag="*",
           description="XML Extensions CodeMirror JavaScript editor.")
public class CodeMirrorXML
extends CodeMirrorBase<CodeMirrorXML.XMLOptions>

CodeMirror editor configured for XML support.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeMirrorXML.SchemaInfo Represents the collection of tags that comprise a schema.
static class	CodeMirrorXML.Tag Represents a single XML tag with its attributes and children.
protected static class	CodeMirrorXML.XMLOptions

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

org.fujion.component.BaseComponent.ComponentReference<T extends org.fujion.component.BaseComponent>, org.fujion.component.BaseComponent.SubComponent

Field Summary

Fields inherited from class org.fujion.codemirror.CodeMirrorBase

options

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
CodeMirrorXML()

Method Summary

Modifier and Type	Method and Description
boolean	getAlignCDATA() Returns the alignCDATA setting.
Boolean	getAutoCloseTags() Returns the autoCloseTags setting.
boolean	getAutoComplete() Returns the autoComplete setting.
String	getJumpShortcut() Returns the key combination that will jump to the tag matching the one currently under the cursor.
boolean	getMatchClosing() Returns the matchClosing setting which controls whether the mode checks that close tags match the corresponding opening tag, and highlights mismatches as errors.
boolean	getMatchTags() Returns the matchTags setting.
boolean	isHtmlMode() Returns the HTML mode setting.
void	setAlignCDATA(boolean alignCDATA) Sets the alignCDATA setting.
void	setAutoCloseTags(Boolean autoCloseTags) Sets the autoCloseTags setting.
void	setAutoComplete(boolean autoComplete) Sets the autoComplete setting.
void	setHtmlMode(Boolean htmlMode) Sets the HTML mode setting.
void	setJumpShortcut(String jumpShortcut) Sets the key combination that will jump to the tag matching the one currently under the cursor.
void	setMatchClosing(boolean matchClosing) Sets the matchClosing setting which controls whether the mode checks that close tags match the corresponding opening tag, and highlights mismatches as errors.
void	setMatchTags(boolean matchTags) Sets the matchTags setting.
void	setSchemaInfo(CodeMirrorXML.SchemaInfo schemaInfo) Sets schema information.

Methods inherited from class org.fujion.codemirror.CodeMirrorBase

_initProps, _toString, _toValue, format, getLineNumbers, getMode, getOptions, getPlaceholder, isReadonly, refreshOptions, setLineNumbers, setMode, setPlaceholder, setReadonly

Methods inherited from class org.fujion.component.BaseInputComponent

_getValue, _onChange, _setValue, _setValue, _toClient, clear, getValue, setValue

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, print, print, removeClass, removeMask, removeStyle, reportSize, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, addChild, addChild, addChild, addChildren, addComposite, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, bringToFront, defaultify, destroy, destroyChildren, detach, detachChildren, disableChildren, disableChildren, finalize, findAllNamed, findAttribute, findByName, findByName, findChild, findChildByData, findChildByLabel, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttributes, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getControllers, getData, getData, getDefinition, getFirstChild, getFirstChild, getId, getIndex, getLastChild, getLastController, getLastController, getName, getNamespace, getNextSibling, getNextSibling, getPage, getParent, getPreviousSibling, getPreviousSibling, getRoot, hasChildren, hasEventListener, hasEventListener, initialize, invoke, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isInitializing, isNamespace, isRendered, loadModule, loadModule, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, propertyChange, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setContent, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validateName, validatePage, validateParent, wireController, wireController

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Methods inherited from interface org.fujion.common.IAttributeMap

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

CodeMirrorXML

public CodeMirrorXML()

Method Detail

getAutoCloseTags

@Component.PropertyGetter(value="autoCloseTags",
                          bindable=false,
                          description="If true, automatically generate closing XML tags.")
public Boolean getAutoCloseTags()

Returns the autoCloseTags setting. If true, the editor will automatically generate closing tags.

Returns:

The autoCloseTags setting.

setAutoCloseTags

@Component.PropertySetter(value="autoCloseTags",
                          bindable=false,
                          defaultValue="true",
                          description="If true, automatically generate closing XML tags.")
public void setAutoCloseTags(Boolean autoCloseTags)

Sets the autoCloseTags setting. If true, the editor will automatically generate closing tags.

Parameters:

autoCloseTags - The autoCloseTags setting.

getMatchTags

@Component.PropertyGetter(value="matchTags",
                          bindable=false,
                          description="If true, highlight matching tag.")
public boolean getMatchTags()

Returns the matchTags setting. If true, the editor will highlight matching tags.

Returns:

The matchTags setting.

setMatchTags

@Component.PropertySetter(value="matchTags",
                          bindable=false,
                          defaultValue="true",
                          description="If true, highlight matching tag.")
public void setMatchTags(boolean matchTags)

Sets the matchTags setting. If true, the editor will highlight matching tags.

Parameters:

matchTags - The matchTags setting.

getAutoComplete

@Component.PropertyGetter(value="autoComplete",
                          bindable=false,
                          description="If true, autocompletion mode is enabled.")
public boolean getAutoComplete()

Returns the autoComplete setting. If true, the editor will present context-sensitive, auto-completion options after certain keystrokes. If false, auto-completion must be invoked manually.

Returns:

The autoComplete setting.

setAutoComplete

@Component.PropertySetter(value="autoComplete",
                          bindable=false,
                          defaultValue="true",
                          description="If true, autocompletion mode is enabled.")
public void setAutoComplete(boolean autoComplete)

Sets the autoComplete setting. If true, the editor will present context-sensitive, auto-completion options after certain keystrokes. If false, auto-completion must be invoked manually.

Parameters:

autoComplete - The autoComplete setting.

isHtmlMode

@Component.PropertyGetter(value="htmlMode",
                          bindable=false,
                          description="If true, sets the mode to parse HTML instead of XML. This means attributes do not have to be quoted, and some elements (such as br) do not require a closing tag.")
public boolean isHtmlMode()

Returns the HTML mode setting. If true, attributes do not have to be quoted, and some elements (such as <br>) do not require a closing tag.

Returns:

The HTML mode setting.

setHtmlMode

@Component.PropertySetter(value="htmlMode",
                          bindable=false,
                          defaultValue="false",
                          description="If true, sets the mode to parse HTML instead of XML. This means attributes do not have to be quoted, and some elements (such as br) do not require a closing tag.")
public void setHtmlMode(Boolean htmlMode)

Sets the HTML mode setting. If true, attributes do not have to be quoted, and some elements (such as <br>) do not require a closing tag.

Parameters:

htmlMode - The HTML mode setting.

getMatchClosing

@Component.PropertyGetter(value="matchClosing",
                          bindable=false,
                          description="Controls whether the mode checks that close tags match the corresponding opening tag, and highlights mismatches as errors.")
public boolean getMatchClosing()

Returns the matchClosing setting which controls whether the mode checks that close tags match the corresponding opening tag, and highlights mismatches as errors.

Returns:

The matchClosing setting.

setMatchClosing

@Component.PropertySetter(value="matchClosing",
                          bindable=false,
                          defaultValue="true",
                          description="Controls whether the mode checks that close tags match the corresponding opening tag, and highlights mismatches as errors. ")
public void setMatchClosing(boolean matchClosing)

Sets the matchClosing setting which controls whether the mode checks that close tags match the corresponding opening tag, and highlights mismatches as errors.

Parameters:

matchClosing - The matchClosing setting.

getAlignCDATA

@Component.PropertyGetter(value="alignCDATA",
                          bindable=false,
                          description="Setting this to true will force the opening tag of CDATA blocks to not be indented.")
public boolean getAlignCDATA()

Returns the alignCDATA setting. When true, the opening tag of CDATA blocks to not be indented.

Returns:

The alignCDATA setting.

setAlignCDATA

@Component.PropertySetter(value="alignCDATA",
                          bindable=false,
                          defaultValue="false",
                          description="Setting this to true will force the opening tag of CDATA blocks to not be indented.")
public void setAlignCDATA(boolean alignCDATA)

Sets the alignCDATA setting. When true, the opening tag of CDATA blocks to not be indented.

Parameters:

alignCDATA - The alignCDATA setting.

getJumpShortcut

@Component.PropertyGetter(value="jumpShortcut",
                          bindable=false,
                          description="Key combination to jump to matching tag.")
public String getJumpShortcut()

Returns the key combination that will jump to the tag matching the one currently under the cursor. Setting to null will disable this feature.

Returns:

Key combination to jump to matching tag.

setJumpShortcut

@Component.PropertySetter(value="jumpShortcut",
                          bindable=false,
                          defaultValue="Alt-J",
                          description="Key combination to jump to matching tag.")
public void setJumpShortcut(String jumpShortcut)

Sets the key combination that will jump to the tag matching the one currently under the cursor. Setting to null will disable this feature.

Parameters:

jumpShortcut - Key combination to jump to matching tag.

setSchemaInfo

public void setSchemaInfo(CodeMirrorXML.SchemaInfo schemaInfo)

Sets schema information.

Parameters:

schemaInfo - The schema information.