harmonic.mz.data
Class FileNode

java.lang.Object
  |
  +--harmonic.mz.data.ModelNode
        |
        +--harmonic.mz.data.FileNode

All Implemented Interfaces:

java.awt.event.ActionListener, DataNode, Documentable, java.util.EventListener, Interpolater, harmonic.meshGeom.math.MarkableObject, NodeListener

public class FileNode

extends ModelNode

This is a special type of ModelNode that is used for the root of a model file.

Field Summary

boolean	bBackUpIsCurrent Whether or not the backup file is current on disk
boolean	bCompressed File should be keeped compressed
static boolean	bCurrentOnCreate
boolean	bCurrentOnDisk Whether or not the model file is the same as the tree in memory
boolean	bLocked If true, model cannot be modified
boolean	bModelFile True if represents a model file.
boolean	bReading If true, model is currently being read from file
ModelNode	currentGeneralList
ModelNode	currentGroup
java.util.Hashtable	currents
java.lang.String	currentTag
java.lang.String	filename
harmonic.viewer3D.LightRack	lightRack Light rack for this model
harmonic.viewer3D.LightRack	selectLightRack Managed to be above, plus a couple others
int	serialNoPos
java.util.Vector	tagList
harmonic.viewer3D.LightRack	tentativeSelectLightRack Managed to be above, plus a couple others

Fields inherited from class harmonic.mz.data.ModelNode

_fileRoot_, _thread_, ATTRIB_CONTROL_WIDGET, ATTRIB_LISTABLE, ATTRIB_PRESENTABLE, ATTRIB_PRIVATE, ATTRIB_REMOVEABLE, ATTRIB_RENAMEABLE, ATTRIB_SHOW_CONTEXT_MENU, ATTRIB_TYPE_FILTER, ATTRIB_USERGROUP, ATTRIB_VALUE_GROUP, ATTRIB_VE_LISTENER, bCustomCS, bDebug, bValid, name

Constructor Summary

FileNode()

FileNode(java.lang.String name)

Method Summary

void	close()
ModelNode	getCurrentGroup() Return the current group to add nodes in this file
java.util.Hashtable	getCurrentsTable() Return String->DataNode mapping of current values
java.lang.String	getFilename() Return filename with directory.
java.lang.String	getTreeName() Override to return lable for tree interface
java.awt.Image	getTypeImage() Returns the image to be used for this node in list interfaces that may put an image by node
boolean	getVisibility(harmonic.viewer3D.Viewport view)
boolean	isModelFile()
void	lock()
void	makeContextMenu(HWM_GroupData menu) May be overrideen to add functions pertaining to this node to context menu.
void	purgeFinal() Called by database when node is intended to never come back, such as when a file is closed or node is deleted out of the undo system.
void	save()
void	setCurrent()
void	setVisibility(boolean bShow, harmonic.viewer3D.Viewport view) Set the visibilitly state with respect to the givin view.
java.lang.String	toString() Prints name for large nodes (with children), the value for small nodes.
void	unlock()

Methods inherited from class harmonic.mz.data.ModelNode

actionPerformed, addAll, addAlphaed, addField, addField, addField, addFields, addNetworkInput, addNetworkOutput, addNode, addNodeListener, addNodeListener, addNodes, addNodes, addToCurrent, addToGlobals, addToNetworkEditor, addToTemps, addWithUndo, allFieldsAreFinal, applyDataTransfer, areFieldsValid, assignFromMetaFields, assignFromXMLAttributes, assignFromXMLString, assignToMetaFields, assignToXMLAttributes, assignToXMLString, at, bind, canSelect, castSelection, checkFileRead, checkNetworkInput, childCount, clean, clearAttrib, clearNotified, compare, copyFrom, createControlWidget, createCopy, createXMLElement, deepCopy, defeatNodeEvents, disableEvents, enableEvents, expectedValidationTime, fileRoot, finalize, findFieldElement, findNode, fromXMLNodes, getAttrib, getBound, getCatagory, getControlWidget, getCurrentNames, getDataTransfer, getDataTransferTypes, getDeleted, getDirectInputs, getDirectOutputs, getEffectors, getEntryListener, getErrorState, getFilterType, getFullName, getHandles, getInstanceURL, getInterpolater, getIsLeaf, getListable, getMark, getMetaFields, getName, getNodeChildren_V, getNodeChildren, getNodeID, getNodeParent, getObjectRep, getPresentable, getPrivate, getReferencePoolName, getRemoteOwner, getRemoveable, getRenameable, getSaveable, getSavedChildren, getSelect, getSeparateDirectInputs, getSeparateDirectOutputs, getSequenced, getSerialNo, getTags, getTentativeSelect, getTransformable, getTransformableParent, getTransient, getTypeURL, getUnfoldedChildren, getUpdateTime, getUserGroup, getValidates, getValue, getXMLNodes, hasDependants, hasExternalRef, hashKey, hasValidationLock, hideControlWidget, indexOf, initControlWidget, insertNode, interpolate_Linear, interpolate_Quadratic, invalidate, isField, isFinal, isInSubtree, isInTree, isLinked, isNotified, isPurged, isSet, isTemporary, isValid, linkedTo, linksChildren, makeFixed, makePrototype, makeReferenced, makeUnreferenced, makeVisibleInGUI, markNotified, mayValidate, nodeChanged, notifyListeners, postAssignFromXMLElement, preAssignToXMLElement, printChildren, printTags, printTree, printTree, purge, pythonString, remove, removeAll, removeAll, removeHandles, removeNetworkInput, removeNetworkOutput, removeNode, removeNode, removeNode, removeNodeListener, replace, selfNodeChanged, set, setActualName, setAttrib, setBound, setCatagory, setChildrenExcept, setCoordSystem, setCurrentControlWidget, setCurrentNames, setDeleted, setEntryListener, setErrorState, setFromPrototype, setIsField, setIsLeaf, setIsSet, setListable, setMark, setMetaFields, setName, setNodeParent, setPresentable, setPrivate, setRemoteOwner, setRemoveable, setRenameable, setSaveable, setSelect, setSelect, setSequenced, setSerialNo, setTentativeSelect, setTentativeSelect, setToLink, setTransient, setTransientChildren, setUpdateTime, setUserGroup, setValidates, setValidationLock, setValue, setValueGroup, showControlWidget, showControlWidget, showControlWidget, showHandles, startRename, tag, unlinkListeners, unmarkNotified, untag, updateBindable, valChanged, valChanged, validate, valueString

Methods inherited from class java.lang.Object

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

Field Detail

filename

public java.lang.String filename

bCurrentOnDisk

public boolean bCurrentOnDisk

Whether or not the model file is the same as the tree in memory

bBackUpIsCurrent

public boolean bBackUpIsCurrent

Whether or not the backup file is current on disk

bLocked

public boolean bLocked

If true, model cannot be modified

bCompressed

public boolean bCompressed

File should be keeped compressed

bReading

public boolean bReading

If true, model is currently being read from file

lightRack

public harmonic.viewer3D.LightRack lightRack

Light rack for this model

selectLightRack

public harmonic.viewer3D.LightRack selectLightRack

Managed to be above, plus a couple others

tentativeSelectLightRack

public harmonic.viewer3D.LightRack tentativeSelectLightRack

Managed to be above, plus a couple others

bModelFile

public boolean bModelFile

True if represents a model file. False untill added to models group by FileManager

currentGroup

public ModelNode currentGroup

currentGeneralList

public ModelNode currentGeneralList

currents

public java.util.Hashtable currents

bCurrentOnCreate

public static boolean bCurrentOnCreate

serialNoPos

public int serialNoPos

currentTag

public java.lang.String currentTag

tagList

public java.util.Vector tagList

Constructor Detail

FileNode

public FileNode()

FileNode

public FileNode(java.lang.String name)

Method Detail

purgeFinal

public void purgeFinal()

Description copied from class: ModelNode

Called by database when node is intended to never come back, such as when a file is closed or node is deleted out of the undo system. Override to purge all memory usded by this node. Its easy to think that just removing the node from the tree would cause it to be garbage collected, but references to nodes can be hard to compleatly remove, so this function exists to minimize the damage of a leaked node.

Specified by:

purgeFinal in interface DataNode

Overrides:

purgeFinal in class ModelNode

getFilename

public java.lang.String getFilename()

Return filename with directory. getName() returns a shorter version.

getCurrentGroup

public ModelNode getCurrentGroup()

Return the current group to add nodes in this file

getCurrentsTable

public java.util.Hashtable getCurrentsTable()

Return String->DataNode mapping of current values

isModelFile

public boolean isModelFile()

getTreeName

public java.lang.String getTreeName()

Description copied from class: ModelNode

Override to return lable for tree interface

Specified by:

getTreeName in interface DataNode

Overrides:

getTreeName in class ModelNode

getTypeImage

public java.awt.Image getTypeImage()

Description copied from class: ModelNode

Returns the image to be used for this node in list interfaces that may put an image by node

Specified by:

getTypeImage in interface DataNode

Overrides:

getTypeImage in class ModelNode

makeContextMenu

public void makeContextMenu(HWM_GroupData menu)

Description copied from class: ModelNode

May be overrideen to add functions pertaining to this node to context menu. The default makes a small general menu.

Overrides:

makeContextMenu in class ModelNode

setCurrent

public void setCurrent()

close

public void close()

save

public void save()

lock

public void lock()

unlock

public void unlock()

toString

public java.lang.String toString()

Description copied from class: ModelNode

Prints name for large nodes (with children), the value for small nodes.

Overrides:

toString in class ModelNode

setVisibility

public void setVisibility(boolean bShow,
                          harmonic.viewer3D.Viewport view)

Set the visibilitly state with respect to the givin view.

getVisibility

public boolean getVisibility(harmonic.viewer3D.Viewport view)