Package mgui.interfaces

Class InterfaceOptions

java.lang.Object
mgui.interfaces.InterfaceOptions
All Implemented Interfaces:
InterfaceObject, NamedObject, TreeObject, CleanableObject
Direct Known Subclasses:
CaminoProcessOptions, CaminoProjectOptions, CaminoTaskOptions, CaretPaintOptions, CorticalThicknessDataTableOptions, CorticalThicknessOptions, DataFieldOptions, DataQueryOptions, DataSourceDriverOptions, DataSourceLinkOptions, DataSourceOptions, DataTableOptions, InterfaceIOOptions, InterfacePlotOptions, InterfaceProjectOptions, MathExpressionOptions, MeshDataMaskOptions, MeshDataOptions, MeshPlaneMaskOptions, MeshSubmeshOptions, PipelineProcessInstanceOptions, PipelineProcessLibraryOptions, PipelineProcessOptions, ProjectDirectoryOptions, ProjectOptions, ScalpAndSkullModelOptions, SgtPlotLayoutOptions, ToolCreateMeshFromPolylinesOptions, ToolCutMeshWithPlaneOptions, ToolGetConvexHull2DOptions, ToolGetMeshIntersectionPolylinesOptions, VideoTaskOptions, VolumeFileWriteOptions, VolumeMaskOptions, VolumeMaskOptions_old
public abstract class InterfaceOptions
extends java.lang.Object
implements InterfaceObject
Base interface for specifying options or parameters for some process.
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Constructor Summary

    Constructors
    Constructor Description
    InterfaceOptions()  

  • Method Summary

    Modifier and Type Method Description
    void clean()
    Instructs this object to search its members for any object which has been destroyed, and release the pointer to it.
    void destroy()
    Destroy this object (prepare it to be removed from memory)
    java.lang.String getName()
    Gets the name for this object.
    java.lang.String getTreeLabel()
    Returns the label text to appear in a tree node.
    boolean isDestroyed()
    Test whether this object has been destroyed
    InterfaceTreeNode issueTreeNode()
    Issues a new InterfaceTreeNode for this object.
    void setName​(java.lang.String name)
    Sets the name for this object.
    void setTreeNode​(InterfaceTreeNode node)
    Sets the children for this node's InterfaceTreeNode.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • InterfaceOptions

      public InterfaceOptions()

  • Method Details

    • clean

      public void clean()
      Description copied from interface: CleanableObject
      Instructs this object to search its members for any object which has been destroyed, and release the pointer to it.
      Specified by:
      clean in interface CleanableObject

    • destroy

      public void destroy()
      Description copied from interface: InterfaceObject
      Destroy this object (prepare it to be removed from memory)
      Specified by:
      destroy in interface InterfaceObject

    • isDestroyed

      public boolean isDestroyed()
      Description copied from interface: InterfaceObject
      Test whether this object has been destroyed
      Specified by:
      isDestroyed in interface InterfaceObject
      Returns:

    • getName

      public java.lang.String getName()
      Description copied from interface: NamedObject
      Gets the name for this object.
      Specified by:
      getName in interface NamedObject
      Returns:

    • setName

      public void setName​(java.lang.String name)
      Description copied from interface: NamedObject
      Sets the name for this object.
      Specified by:
      setName in interface NamedObject

    • issueTreeNode

      public InterfaceTreeNode issueTreeNode()
      Description copied from interface: TreeObject
      Issues a new InterfaceTreeNode for this object. The object is responsible for maintaining, updating, and destroying the tree nodes it issues, or notifying containers -- i.e., parent trees -- of changes which require the tree nodes to be modified or destroyed.
      Specified by:
      issueTreeNode in interface TreeObject
      Returns:

    • setTreeNode

      public void setTreeNode​(InterfaceTreeNode node)
      Description copied from interface: TreeObject
      Sets the children for this node's InterfaceTreeNode.
      Specified by:
      setTreeNode in interface TreeObject

    • getTreeLabel

      public java.lang.String getTreeLabel()
      Description copied from interface: TreeObject
      Returns the label text to appear in a tree node.
      Specified by:
      getTreeLabel in interface TreeObject
      Returns: