|
Oxygen XML Editor 12.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.exml.workspace.api.editor.page.text.WSTextXMLSchemaManager
public abstract class WSTextXMLSchemaManager
Text page XML schema manager. Provides support for obtaining information about what elements, attributes can be inserted in a given context.
Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
Constructor Summary | |
---|---|
WSTextXMLSchemaManager()
|
Method Summary | |
---|---|
abstract WhatAttributesCanGoHereContext |
createWhatAttributesCanGoHereContext(int offset)
Create a context for the given element that can be used to obtain the list with attributes that element accepts. |
abstract WhatElementsCanGoHereContext |
createWhatElementsCanGoHereContext(int offset)
Create an element context for the given offset. |
abstract WhatPossibleValuesHasAttributeContext |
createWhatPossibleValuesHasAttributeContext(int offset)
Create an attribute values context for the given element and attribute name. |
abstract CIAttribute |
getAttributeDescription(WhatPossibleValuesHasAttributeContext ctxt)
Get the description of an attribute. |
abstract java.util.List<CIElement> |
getChildrenElements(WhatElementsCanGoHereContext context)
Get the elements that can be children of the element for which the context was built. |
abstract CIElement |
getElementDescription(Context ctxt)
Get the description of an element. |
abstract java.util.List<NameValue> |
getEntities()
Gets the context-independent list of entities declared in the document's DOCTYPE declaration. |
abstract java.util.List<CIElement> |
getGlobalElements()
Get all the names of global elements defined in the associated grammar. |
abstract java.net.URL[] |
getGrammarURLs()
Get the array of URLs of the loaded DTD or XML Schema. |
abstract boolean |
hasLoadingErrors()
|
abstract boolean |
isElementDescriptionSupported()
If true the element description(model) support is available, otherwise not. |
abstract boolean |
isLearnSchema()
|
abstract java.util.List<CIAttribute> |
whatAttributesCanGoHere(WhatAttributesCanGoHereContext whatAttributesCanGoHereContext)
Examines the grammar and decides what attributes can be inserted in the parent element, after the list of attributes names. |
abstract java.util.List<CIElement> |
whatElementsCanGoHere(WhatElementsCanGoHereContext whatElementsCanGoHereContext)
Examines the grammar and decides what elements can be inserted in the parent element, after the list of child names. |
abstract java.util.List<CIValue> |
whatPossibleValuesHasAttribute(WhatPossibleValuesHasAttributeContext ctxt)
Queries the possible values of an element attribute. |
abstract java.util.List<CIValue> |
whatPossibleValuesHasElement(WhatElementsCanGoHereContext ctxt)
Queries the possible values of an element. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WSTextXMLSchemaManager()
Method Detail |
---|
public abstract WhatElementsCanGoHereContext createWhatElementsCanGoHereContext(int offset) throws javax.swing.text.BadLocationException
offset
- Offset in document for which to create an element context.
javax.swing.text.BadLocationException
- When the offset is below zero or greater than the content.public abstract WhatAttributesCanGoHereContext createWhatAttributesCanGoHereContext(int offset)
offset
- The current offset
whatAttributesCanGoHere(WhatAttributesCanGoHereContext)
public abstract WhatPossibleValuesHasAttributeContext createWhatPossibleValuesHasAttributeContext(int offset)
offset
- The offset of the attribute name on the element whose attribute values interest us.
public abstract java.util.List<CIAttribute> whatAttributesCanGoHere(WhatAttributesCanGoHereContext whatAttributesCanGoHereContext)
whatAttributesCanGoHereContext
- the context for the call. It must
have:
public abstract java.util.List<CIElement> whatElementsCanGoHere(WhatElementsCanGoHereContext whatElementsCanGoHereContext)
whatElementsCanGoHereContext
- the context for the call. It must have:
public abstract java.util.List<CIValue> whatPossibleValuesHasAttribute(WhatPossibleValuesHasAttributeContext ctxt)
ctxt
- The context WhatPossiBleValuesHasAttributeContext.
public abstract java.util.List<CIValue> whatPossibleValuesHasElement(WhatElementsCanGoHereContext ctxt)
ctxt
- The context.
public abstract java.net.URL[] getGrammarURLs()
update(InputSource[])
methods.
public abstract CIAttribute getAttributeDescription(WhatPossibleValuesHasAttributeContext ctxt)
ctxt
- the context describing the target attribute.
public abstract java.util.List<NameValue> getEntities()
If the DOCTYPE declaration is not changed, the document should not be processed each time this method is called.
public abstract CIElement getElementDescription(Context ctxt)
ctxt
- the context describing the target element. It contains:public abstract boolean isElementDescriptionSupported()
public abstract java.util.List<CIElement> getChildrenElements(WhatElementsCanGoHereContext context)
context
- The element context.
public abstract boolean isLearnSchema()
public abstract boolean hasLoadingErrors()
public abstract java.util.List<CIElement> getGlobalElements()
|
Oxygen XML Editor 12.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |