com.xmlmind.xmleditapp.config

Class ElementVisibilityInfo

java.lang.Object

com.xmlmind.xmleditapp.config.Info

com.xmlmind.xmleditapp.config.NamedItemVisibilityInfo

com.xmlmind.xmleditapp.config.ElementVisibilityInfo

public final class ElementVisibilityInfo
extends NamedItemVisibilityInfo

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xmleditapp.config.Info

Info.CompareInfoByKey

Field Summary

Fields

Modifier and Type	Field and Description
static Name	CLASS_ELEMENT
static String	CONFIG_NAME_VAR
static Name	ELEMENTS_ATTRIBUTE
static Name	INCLUDE_ELEMENT
static Name	LOCATION_ATTRIBUTE
static Name	NAME_ATTRIBUTE
static Name	PLATFORM_ATTRIBUTE
static String[]	PLATFORM_ATTRIBUTE_VALUES

Fields inherited from class com.xmlmind.xmleditapp.config.NamedItemVisibilityInfo

CATEGORY_ELEMENT, MERGE_ATTRIBUTE, mutableCopies, namedItemVisibility, VISIBLE_ATTRIBUTE

Fields inherited from class com.xmlmind.xmleditapp.config.Info

compareInfoByKey

Constructor Summary

Constructors

Constructor and Description
ElementVisibilityInfo()
ElementVisibilityInfo(ElementVisibility elemVisibility)

Method Summary

Modifier and Type	Method and Description
ElementVisibilityInfo	copy() Returns a deep copy of this info object.
protected NamedItemVisibility	createContainer(NamedItemVisibility.Category[] list)
ElementVisibility	getElementVisibility() The stock element visibility of this configuration.
boolean	load(Element element, LoadContext loadContext, List<LoadError> errors) Updates this info object using data contained in specified XML element.
boolean	save(NamespaceToPrefixes nsToPrefixes, Element parent) Saves this info object as XML by inserting one or more XML elements in the root element of specified document.
void	setElementVisibility(Document doc, String preferencesKey, Preferences preferences)

Methods inherited from class com.xmlmind.xmleditapp.config.NamedItemVisibilityInfo

load, parseCategory, save, translate

Methods inherited from class com.xmlmind.xmleditapp.config.Info

getKey, getType

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENTS_ATTRIBUTE

public static final Name ELEMENTS_ATTRIBUTE

CLASS_ELEMENT

public static final Name CLASS_ELEMENT

INCLUDE_ELEMENT

public static final Name INCLUDE_ELEMENT

LOCATION_ATTRIBUTE

public static final Name LOCATION_ATTRIBUTE

PLATFORM_ATTRIBUTE

public static final Name PLATFORM_ATTRIBUTE

NAME_ATTRIBUTE

public static final Name NAME_ATTRIBUTE

PLATFORM_ATTRIBUTE_VALUES

public static final String[] PLATFORM_ATTRIBUTE_VALUES

CONFIG_NAME_VAR

public static final String CONFIG_NAME_VAR

See Also:

Constant Field Values

Constructor Detail

ElementVisibilityInfo

public ElementVisibilityInfo()

ElementVisibilityInfo

public ElementVisibilityInfo(ElementVisibility elemVisibility)

Method Detail

copy

public ElementVisibilityInfo copy()

Description copied from class: Info

Returns a deep copy of this info object.

Specified by:

copy in class Info

getElementVisibility

public ElementVisibility getElementVisibility()

The stock element visibility of this configuration. May return null. May not be modified.

setElementVisibility

public void setElementVisibility(Document doc,
                                 String preferencesKey,
                                 Preferences preferences)

load

public boolean load(Element element,
                    LoadContext loadContext,
                    List<LoadError> errors)

Description copied from class: Info

Updates this info object using data contained in specified XML element.

Specified by:

load in class Info

Parameters:

element - XML element used to update this info object

loadContext - a context object created by the Loader

errors - if element is found to be invalid, LoadErrors are added to this list

Returns:

true if the info object has been successfully updated; false otherwise

createContainer

protected NamedItemVisibility createContainer(NamedItemVisibility.Category[] list)

Specified by:

createContainer in class NamedItemVisibilityInfo

save

public boolean save(NamespaceToPrefixes nsToPrefixes,
                    Element parent)

Description copied from class: Info

Saves this info object as XML by inserting one or more XML elements in the root element of specified document.

Specified by:

save in class Info

Parameters:

nsToPrefixes - A namespace to prefix map which may be used to convert objects such as XPaths to their string representation

parent - one or more child elements are appended to this parent element

Returns:

true if child elements have been added to the parent element; false otherwise (generally because this info object is ``empty'' and therefore there is nothing to be saved)