com.xmlmind.xmledit.cmd.edit

Class NamedItemVisibility

java.lang.Object

com.xmlmind.xmledit.cmd.edit.NamedItemVisibility

Direct Known Subclasses:

AttributeVisibility, ElementVisibility

public abstract class NamedItemVisibility
extends Object

The base class of the objects used to specify which rarely used elements or attributes (thats is, Name-ed items) are to be kept hidden to the user to prevent editing tools like the FieldChooser from being cluttered.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NamedItemVisibility.Category
static class	NamedItemVisibility.NamedItem

Field Summary

Fields

Modifier and Type	Field and Description
NamedItemVisibility.Category[]	categories
static NamedItemVisibility.Category[]	NO_CATEGORIES
static NamedItemVisibility.NamedItem[]	NO_NAMED_ITEM
protected String	preferencesKey

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NamedItemVisibility(NamedItemVisibility.Category[] categories)

Method Summary

Modifier and Type	Method and Description
protected void	clearHiddenNamedItems()
NamedItemVisibility	copy() Returns a copy where Category.visible can be safely modified.
protected Map<Name,NamedItemVisibility.NamedItem>	getHiddenNamedItems()
String	getPreferencesKey()
boolean	isVisible(Name itemName, Element parent)
void	loadFromPreferences(Preferences prefs)
void	setPreferencesKey(String key)
protected abstract boolean	testIsVisible(NamedItemVisibility.NamedItem namedItem, Element parent)

Methods inherited from class java.lang.Object

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

Field Detail

NO_NAMED_ITEM

public static final NamedItemVisibility.NamedItem[] NO_NAMED_ITEM

NO_CATEGORIES

public static final NamedItemVisibility.Category[] NO_CATEGORIES

categories

public final NamedItemVisibility.Category[] categories

preferencesKey

protected String preferencesKey

Constructor Detail

NamedItemVisibility

protected NamedItemVisibility(NamedItemVisibility.Category[] categories)

Method Detail

clearHiddenNamedItems

protected void clearHiddenNamedItems()

getHiddenNamedItems

protected Map<Name,NamedItemVisibility.NamedItem> getHiddenNamedItems()

copy

public NamedItemVisibility copy()

Returns a copy where Category.visible can be safely modified.

isVisible

public boolean isVisible(Name itemName,
                         Element parent)

testIsVisible

protected abstract boolean testIsVisible(NamedItemVisibility.NamedItem namedItem,
                                         Element parent)

setPreferencesKey

public void setPreferencesKey(String key)

getPreferencesKey

public String getPreferencesKey()

loadFromPreferences

public void loadFromPreferences(Preferences prefs)