Module platform.core

Package de.grogra.pf.registry

Class Option

java.lang.Object

de.grogra.graph.impl.Edge

de.grogra.graph.impl.Node

de.grogra.pf.registry.Item

de.grogra.pf.registry.ObjectItem

de.grogra.pf.registry.LazyObjectItem

de.grogra.pf.registry.Value

de.grogra.pf.registry.Option

All Implemented Interfaces:

Manageable, PersistenceCapable, Shareable, SharedObjectProvider, RegistryContext, UserFields, XObject, Described, KeyDescription, Map, Serializable

Direct Known Subclasses:

ShortCut

public class Option
extends Value
implements KeyDescription

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.grogra.graph.impl.Node

Node.AccessorBridge, Node.FieldAttributeAccessor, Node.NType

Nested classes/interfaces inherited from interface de.grogra.util.Map

Map.Chain

Nested classes/interfaces inherited from interface de.grogra.persistence.SharedObjectProvider

SharedObjectProvider.Binding

Field Summary

Fields

Modifier and Type	Field	Description
static final Node.NType	$TYPE
static final String	OPTIONS_FILE
static final String	PROJECT_OPTIONS_PATH

Fields inherited from class de.grogra.pf.registry.Value

value$FIELD

Fields inherited from class de.grogra.pf.registry.LazyObjectItem

fetch$FIELD

Fields inherited from class de.grogra.pf.registry.ObjectItem

objDescribes$FIELD, type$FIELD, USED_BITS

Fields inherited from class de.grogra.pf.registry.Item

systemId, systemId$FIELD

Fields inherited from class de.grogra.graph.impl.Node

ADDITIONAL_FIELDS, bits, DELETED, EXTENT_BIT, EXTENT_MASK, extentIndex$FIELD, extentTail$FIELD, HAS_OBSERVERS, IS_INTERPRETIVE, isInterpretive$FIELD, LAST_EXTENT_INDEX, layer$FIELD, MARK, mark$FIELD, MAX_RESOLUTION, MIME_TYPE, MIN_RESOLUTION, MIN_UNUSED_SPECIAL_OF_SOURCE, MIN_UNUSED_SPECIAL_OF_TARGET, name$FIELD, RESOLUTION_BIT, RESOLUTION_MASK, resolution$FIELD

Fields inherited from interface de.grogra.util.Described

ACCELERATOR_KEY, ICON, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, TITLE

Fields inherited from interface de.grogra.util.Map

DEFAULT_VALUE, EMPTY_MAP

Constructor Summary

Constructors

Constructor	Description
Option()

Method Summary

Modifier and Type	Method	Description
protected void	activateImpl()
boolean	belongsToGroup(Item item)
static Option	createNoneditableOption(String name, Object value)
static Option	get(Item item, String option)
static Option[]	getEditableOptions(Item i, boolean includeTransient)	Returns all options in the subtree starting with i which are editable or transient (the latter only if includeTransient is true).
String	getKey()	Returns the key which is described by this instance.
protected Node.NType	getNTypeImpl()	This method returns the Node.NType which describes the managed fields of the class of this node.
Object	getObject()	Load the value of an option either: - based on the workbench.options file within a workbench (see OptionBase) if the workbench contains that file - based on the global preferences - registry option
Object	getObject(Registry r)	Load the value of an option either: - based on the workbench.options file within a workbench (see OptionBase) if the workbench contains that file - based on the global preferences - registry option
static String	getPreference(Item item)
Quantity	getQuantity()	Returns the quantity of values which are associated with the key.
Type	getType()	Returns the type of values which are associated with the key.
protected boolean	getTypeFromObject()
static boolean	hasEditableOptions(Item item)
boolean	isEditable()
boolean	isTransient()
protected Node	newInstance()	This method returns a new instance of the class of this node.
protected boolean	readAttribute(String uri, String name, String value)
void	setOptionValue(Object value)	The value is set to either: - the OptionBase object (in the workbench.options file of the workbench) if the option is set locally - to the Option (this) object value$FIELD and to the java pref if it is set globally
static void	setPreference(Item item, String value)

Methods inherited from class de.grogra.pf.registry.Value

fetchBaseObject, getAttributes, hasNullValue, setValue

Methods inherited from class de.grogra.pf.registry.LazyObjectItem

addPluginPrerequisites, getBaseObjectImpl, isObjectFetched, setBaseObject

Methods inherited from class de.grogra.pf.registry.ObjectItem

addToRegistry, createReference, getDerivedDescription, getObjectType, getProviderName, isInstance, isInstance, isInstance, readReference, setObjDescribes, setType, writeObject

Methods inherited from class de.grogra.pf.registry.Item

activate, add, add, addPluginPrerequisite, addRequiredFiles, addUserItem, addUserItemWithUniqueName, addWithUniqueName, beginXA, classForName, commitXA, copy, createItem, deactivate, deactivateImpl, delete, deriveItems, dupUnmanagedFields, equals, findAll, findAll, findAll, findFirst, findFirst, findFirst, findMax, findMax, findMax, forAll, forAll, forAll, get, getAbsoluteName, getAccessor, getAccessor, getAttributes, getClassLoader, getDefaultDescription, getDefaultValue, getDescription, getDescriptionImpl, getFromResource, getI18NBundle, getItem, getLock, getParentMap, getPath, getPluginDescriptor, getRegistry, getRoot, getSystemId, getTransaction, getUniqueName, getWriteLock, hasEditableOptions, initPluginDescriptor, isActivated, isDirectory, isEditable, isOptionCategory, isPluginItem, isUserItem, makeUserItem, paramString, remove, removeDerivedItems, resolveItem, resolveLink, set, setDefaultDescription, setDescription, setDescription, setDirectory, setName, setNameIfNull, setOption, substitute, validate

Methods inherited from class de.grogra.graph.impl.Node

addEdgeBitsTo, addReference, appendBranchNode, appendBranchNode, appendReferencesTo, clone, clone, cloneGraph, dump, dumpTree, dup, dupFrom, dupnew, edgeChanged, fieldModified, findAdjacent, findRefinementType, getAxisParent, getBoolean, getBranch, getBranchLength, getBranchNode, getBranchTail, getByte, getChar, getCommonAncestor, getCurrentGraphState, getDirectChildCount, getDouble, getEdgeAttributeAccessor, getEdgeAttributes, getEdgeBitsTo, getEdgeTo, getExtentIndex, getFirst, getFirstEdge, getFloat, getGraph, getId, getIgnored, getIndex, getInstantiator, getInt, getLayer, getLong, getManageableType, getName, getNeighbor, getNext, getNType, getObject, getOrCreateEdgeTo, getOrNull, getPersistenceManager, getPredecessor, getProvider, getResolution, getShort, getSource, getStamp, getSuccessor, getSymbol, getSymbolColor, getTarget, getTransaction, getUserField, getUserFieldCount, getXClass, getXData, hasName, initProvider, initXClass, insertBranchNode, insertBranchNode, instantiateGraph, isAncestorOf, isDirection, isEncoarseOf, isManagingInstance, isMarked, isRoot, isSource, isTarget, manageableReadResolve, manageableWriteReplace, removeAll, removeEdgeBitsTo, removeFromChain, removeFromChain, removeReference, setBranch, setBranch, setExtentIndex, setGraphForDeserialization, setIgnored, setLayer, setMark, setResolution, setSuccessor, setSuccessor, specialEdgeAdded, specialEdgeRefModified, specialEdgeRemoved, toString, writeReplace

Methods inherited from class de.grogra.graph.impl.Edge

addEdgeBits, getBitMark, getEdgeBits, getEdgeKeys, getObjectMark, getSpecialEdgeDescriptor, parseEdgeKeys, remove, removeEdgeBits, setBitMark, setEdgeBits, setObjectMark, testEdgeBits

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.grogra.util.Described

getDescription

Methods inherited from interface de.grogra.persistence.PersistenceCapable

getBitMark, getObjectMark, setBitMark, setObjectMark

Field Details

OPTIONS_FILE

public static final String OPTIONS_FILE

See Also:

• Constant Field Values

PROJECT_OPTIONS_PATH

public static final String PROJECT_OPTIONS_PATH

See Also:

• Constant Field Values

$TYPE

public static final Node.NType $TYPE

Constructor Details

Option

public Option()

Method Details

getNTypeImpl

protected Node.NType getNTypeImpl()

Description copied from class: Node

This method returns the Node.NType which describes the managed fields of the class of this node. This method has to be implemented in every concrete subclass.

Overrides:

getNTypeImpl in class Value

Returns:

type describing the managed fields of the class of this node

newInstance

protected Node newInstance()

Description copied from class: Node

This method returns a new instance of the class of this node. This method has to be implemented in every concrete subclass.

Overrides:

newInstance in class Value

Returns:

new instance of class of this node

getTypeFromObject

protected boolean getTypeFromObject()

Overrides:

getTypeFromObject in class LazyObjectItem

createNoneditableOption

public static Option createNoneditableOption(String name,
 Object value)

isEditable

public boolean isEditable()

isTransient

public boolean isTransient()

setPreference

public static void setPreference(Item item,
 String value)

getPreference

public static String getPreference(Item item)

belongsToGroup

public boolean belongsToGroup(Item item)

getKey

public String getKey()

Description copied from interface: KeyDescription

Returns the key which is described by this instance.

Specified by:

getKey in interface KeyDescription

Returns:

the key

getType

public Type getType()

Description copied from interface: KeyDescription

Returns the type of values which are associated with the key.

Specified by:

getType in interface KeyDescription

Returns:

the type of values

getQuantity

public Quantity getQuantity()

Description copied from interface: KeyDescription

Returns the quantity of values which are associated with the key.

Specified by:

getQuantity in interface KeyDescription

Returns:

the quantity of values

setOptionValue

public void setOptionValue(Object value)

The value is set to either: - the OptionBase object (in the workbench.options file of the workbench) if the option is set locally - to the Option (this) object value$FIELD and to the java pref if it is set globally

Parameters:

value -

activateImpl

protected void activateImpl()

Overrides:

activateImpl in class Item

getObject

public Object getObject()

Load the value of an option either: - based on the workbench.options file within a workbench (see OptionBase) if the workbench contains that file - based on the global preferences - registry option

Overrides:

getObject in class LazyObjectItem

getObject

public Object getObject(Registry r)

Load the value of an option either: - based on the workbench.options file within a workbench (see OptionBase) if the workbench contains that file - based on the global preferences - registry option

readAttribute

protected boolean readAttribute(String uri,
 String name,
 String value)
                         throws SAXException

Overrides:

readAttribute in class Value

Throws:

SAXException

get

public static Option get(Item item,
 String option)

hasEditableOptions

public static boolean hasEditableOptions(Item item)

getEditableOptions

public static Option[] getEditableOptions(Item i,
 boolean includeTransient)

Returns all options in the subtree starting with i which are editable or transient (the latter only if includeTransient is true). Links having the name "option" are resolved.

Parameters:

i - the item to start with

includeTransient - include transient options?

Returns:

an array of all editable options in the subtree starting with i