All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class mesquite.lib.FileElement

java.lang.Object
   |
   +----mesquite.lib.Listened
           |
           +----mesquite.lib.Associable
                   |
                   +----mesquite.lib.AssociableWithSpecs
                           |
                           +----mesquite.lib.FileElement

public class FileElement

extends mesquite.lib.AssociableWithSpecs

implements mesquite.lib.Identifiable, mesquite.lib.Listable, mesquite.lib.Renamable, mesquite.lib.FileDirtier, mesquite.lib.HNode, mesquite.lib.Commandable, mesquite.lib.Explainable, mesquite.lib.Annotatable

assignedIDNumber

DIRTY

Element is dirty (returned by close()).

disposed

doomed

IN_USE

Element is in use (returned by close()).

name

OK

Element was disposed (returned by close()).

totalCreated

FileElement()

FileElement(int)

addToBrowserPopup(MesquitePopup)

addToFile(MesquiteFile, MesquiteProject, ElementManager)

Adds the element to the given file and project, and assigns it the given manager.

deleteMe(boolean)

dispose()

Deletes the file element.

doCommand(String, String, CommandRecord, CommandChecker)

Performs command (for Commandable interface)

doom()

fileDirtiedByCommand(MesquiteCommand)

for FileDirtier interface

getExplanation()

Returns the explanation (e.g., footnote with additional information) of this element

getFile()

Gets file to which the FileElement belongs

getFileName()

Gets name of the file to which the element belongs

getHColor()

getHDaughters()

getHImage()

getHMother()

getHShow()

getID()

getManager()

Returns the FileElement's managing module

getName()

Returns name of this element

getNexusBlock()

Gets the associated NexusBlock of the FileElement

getNumSupplements()

getProject()

Gets project to which the FileElement belongs

getSupplementName(int)

getTypeName()

Returns the type of this element (e.g., "Continuous Data Matrix")

hNodeAction(Container, int, int, int)

hSupplementTouched(int)

isDoomed()

okToClose(int)

NOT YET FUNCTIONING If queryUser is true, then if there is a problem with deletion the user will be queried.

setFile(MesquiteFile)

Sets the file to which the FileElement belongs

setManager(ElementManager)

Sets the FileElement's managing module

setName(String)

Sets the name of this element

setProject(MesquiteProject)

Sets project to which the FileElement belongs

 public static final int OK

Element was disposed (returned by close()).

 public static final int IN_USE

Element is in use (returned by close()).

 public static final int DIRTY

Element is dirty (returned by close()).

 public static long totalCreated

 public long assignedIDNumber

 protected java.lang.String name

 protected boolean disposed

 protected boolean doomed

 public FileElement(int numParts)

 public FileElement()

 public long getID()

 public java.lang.String getTypeName()

Returns the type of this element (e.g., "Continuous Data Matrix")

 public java.lang.String getName()

Returns name of this element

 public void setName(java.lang.String name)

Sets the name of this element

 public java.lang.String getExplanation()

Returns the explanation (e.g., footnote with additional information) of this element

 public java.lang.Object doCommand(java.lang.String commandName,
                                   java.lang.String arguments,
                                   mesquite.lib.CommandRecord commandRec,
                                   mesquite.lib.CommandChecker checker)

Performs command (for Commandable interface)

Overrides:

doCommand in class mesquite.lib.Associable

 public void deleteMe(boolean queryUser)

 public mesquite.lib.NexusBlock addToFile(mesquite.lib.MesquiteFile f,
                                          mesquite.lib.MesquiteProject proj,
                                          mesquite.lib.duties.ElementManager manager)

Adds the element to the given file and project, and assigns it the given manager. Also takes care of notifying the manager that it has been added using elementAdded().

 public mesquite.lib.NexusBlock getNexusBlock()

Gets the associated NexusBlock of the FileElement

 public void fileDirtiedByCommand(mesquite.lib.MesquiteCommand command)

for FileDirtier interface

 public mesquite.lib.MesquiteProject getProject()

Gets project to which the FileElement belongs

 public void setProject(mesquite.lib.MesquiteProject project)

Sets project to which the FileElement belongs

 public mesquite.lib.MesquiteFile getFile()

Gets file to which the FileElement belongs

 public void setFile(mesquite.lib.MesquiteFile f)

Sets the file to which the FileElement belongs

 public java.lang.String getFileName()

Gets name of the file to which the element belongs

 public void setManager(mesquite.lib.duties.ElementManager e)

Sets the FileElement's managing module

 public mesquite.lib.duties.ElementManager getManager()

Returns the FileElement's managing module

 public boolean isDoomed()

 public void doom()

 public void dispose()

Deletes the file element. Should typically be called via close() to make sure that the file element is not in use etc.

Overrides:

dispose in class mesquite.lib.AssociableWithSpecs

 public int okToClose(int queryUser)

NOT YET FUNCTIONING If queryUser is true, then if there is a problem with deletion the user will be queried. Otherwise, the deletion is done or not according to whether there are problems with deletion, and the method returns whether the deletion was successful

 public mesquite.lib.HNode[] getHDaughters()

 public mesquite.lib.HNode getHMother()

 public int getNumSupplements()

 public java.lang.String getSupplementName(int index)

 public void hNodeAction(java.awt.Container c,
                         int x,
                         int y,
                         int action)

 public void addToBrowserPopup(mesquite.lib.MesquitePopup popup)

 public void hSupplementTouched(int index)

 public java.awt.Image getHImage()

 public java.awt.Color getHColor()

 public boolean getHShow()

All Packages  Class Hierarchy  This Package  Previous  Next  Index