|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectro.sync.contentcompletion.xml.SchemaManagerFilterBase
ro.sync.contentcompletion.xml.StyleGuideSchemaManagerFilterBase
@API(type=EXTENDABLE, src=PUBLIC) public abstract class StyleGuideSchemaManagerFilterBase
Style guide schema manager filter base. The default implementation adds annotations to elements and attributes by looking into a mapping file URI which is passed through the XML Catalog system...
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.
Field Summary | |
---|---|
protected static ro.sync.exml.MessageBundle |
messages
The messages resource bundle. |
Constructor Summary | |
---|---|
StyleGuideSchemaManagerFilterBase(java.lang.String locationOfMappingFile)
Constructor. |
Method Summary | |
---|---|
java.util.List<ro.sync.contentcompletion.xml.CIAttribute> |
filterAttributes(java.util.List<ro.sync.contentcompletion.xml.CIAttribute> attributes,
ro.sync.contentcompletion.xml.WhatAttributesCanGoHereContext context)
Filters the attributes proposed by the editor content completion schema manager. |
java.util.List<ro.sync.contentcompletion.xml.CIElement> |
filterElements(java.util.List<ro.sync.contentcompletion.xml.CIElement> elements,
ro.sync.contentcompletion.xml.WhatElementsCanGoHereContext context)
Filters the elements proposed by the editor content completion schema manager. |
ro.sync.contentcompletion.xml.CIElement |
getElementDescription(ro.sync.contentcompletion.xml.CIElement element,
ro.sync.contentcompletion.xml.Context ctxt)
Get element description, contributes HTML annotation to it.. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface ro.sync.contentcompletion.xml.SchemaManagerFilter |
---|
filterAttributeValues, filterElementValues |
Methods inherited from interface ro.sync.ecss.extensions.api.Extension |
---|
getDescription |
Field Detail |
---|
protected static final ro.sync.exml.MessageBundle messages
Constructor Detail |
---|
public StyleGuideSchemaManagerFilterBase(java.lang.String locationOfMappingFile)
locationOfMappingFile
- Location of the mapping file.Method Detail |
---|
public java.util.List<ro.sync.contentcompletion.xml.CIElement> filterElements(java.util.List<ro.sync.contentcompletion.xml.CIElement> elements, ro.sync.contentcompletion.xml.WhatElementsCanGoHereContext context)
SchemaManagerFilter
person
is the current CIElement
,
and the list of children contains the elements name
and address
, the result of choosing
the person entry from the content completion window
will be the insertion of the following sequence:
<person>
<name>...</name>
<address>...</address>
</person>
Given this example, the original name
CIElement can be replaced
by a new one which returns a list with two new CIElements, firstName
and
lastName
, on the CIElement.getGuessElements()
method call.
The new generated sequence would be:
<person>
<name>
<firstName>...</firstName>
<lastName>...</lastName>
</name>
<address>...</address>
</person>
elements
- The list of elements (CIElement
) to be filtered.context
- The WhatElementsCanGoHereContext
where the list of
elements is requested.
If null
then the given list of content completion elements contains
global elements.
CIElement
or null
if all elements
are rejected by the filter.SchemaManagerFilter.filterElements(java.util.List, ro.sync.contentcompletion.xml.WhatElementsCanGoHereContext)
public java.util.List<ro.sync.contentcompletion.xml.CIAttribute> filterAttributes(java.util.List<ro.sync.contentcompletion.xml.CIAttribute> attributes, ro.sync.contentcompletion.xml.WhatAttributesCanGoHereContext context)
SchemaManagerFilter
attributes
- The list of attributes (CIAttribute
) to be filtered. Can be NULLcontext
- The WhatAttributesCanGoHereContext
where the list of
attributes is requested.
CIAttribute
or null
if all attributes
are rejected by the filter.SchemaManagerFilter.filterAttributes(java.util.List, ro.sync.contentcompletion.xml.WhatAttributesCanGoHereContext)
public ro.sync.contentcompletion.xml.CIElement getElementDescription(ro.sync.contentcompletion.xml.CIElement element, ro.sync.contentcompletion.xml.Context ctxt)
getElementDescription
in class SchemaManagerFilterBase
element
- The CIElementctxt
- The context.
|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |