com.xmlmind.xmleditapp.docset

Class DocumentSetBase

java.lang.Object

com.xmlmind.xmleditapp.docset.DocumentSetBase

All Implemented Interfaces:

Constants, DocumentSet

Direct Known Subclasses:

ModularDocument, PageSet, TopicSet, TopicSet

public abstract class DocumentSetBase
extends Object
implements DocumentSet

An abstract base class implementing getActionsAfterUpdate(com.xmlmind.xml.doc.Document), setClientProperty(java.lang.Object, java.lang.Object) and getClientProperty(java.lang.Object).

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<Object,Object>	clientProperties

Fields inherited from interface com.xmlmind.xmleditapp.docset.DocumentSet

ACTION_REDRAW, ACTION_TRANSCLUDE, ACTION_VALIDATE

Fields inherited from interface com.xmlmind.xmleditapp.docset.Constants

DOCUMENT_SET_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentSetBase()

Method Summary

Modifier and Type	Method and Description
int	getActionsAfterUpdate(Document memberDoc) Returns an OR-set of actions specifying which actions to perform on specified member document after a document set has been updated.
Object	getClientProperty(Object key) Returns the value of the "client property" with the specified key.
Object	setClientProperty(Object key, Object value) Add, replace or remove specified "client property".

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xmlmind.xmleditapp.docset.DocumentSet

getMemberURLs, getMemberURLSet, getSpecificationURL, update

Field Detail

clientProperties

protected HashMap<Object,Object> clientProperties

Constructor Detail

DocumentSetBase

protected DocumentSetBase()

Method Detail

getActionsAfterUpdate

public int getActionsAfterUpdate(Document memberDoc)

Returns an OR-set of actions specifying which actions to perform on specified member document after a document set has been updated.

Returns DocumentSet.ACTION_VALIDATE whatever the contents of specified member document.

Specified by:

getActionsAfterUpdate in interface DocumentSet

Parameters:

memberDoc - a member of this document set

Returns:

an OR-set of actions DocumentSet.ACTION_VALIDATE, DocumentSet.ACTION_REDRAW, DocumentSet.ACTION_TRANSCLUDE

See Also:

DocumentSet.update(com.xmlmind.util.Console)

setClientProperty

public Object setClientProperty(Object key,
                                Object value)

Description copied from interface: DocumentSet

Add, replace or remove specified "client property".

Specified by:

setClientProperty in interface DocumentSet

Parameters:

key - the property key

value - the property value; specify null to remove the property with the specified key

Returns:

the replaced or removed value of the property if any; null otherwise

See Also:

DocumentSet.getClientProperty(java.lang.Object)

getClientProperty

public Object getClientProperty(Object key)

Description copied from interface: DocumentSet

Returns the value of the "client property" with the specified key.

Specified by:

getClientProperty in interface DocumentSet

Parameters:

key - the property key

Returns:

the value of the property if found; null otherwise

See Also:

DocumentSet.setClientProperty(java.lang.Object, java.lang.Object)