com.acarter.scenemonitor.textdescriptor
Class A_TextDescriptor

java.lang.Object
  extended by com.acarter.scenemonitor.textdescriptor.A_TextDescriptor
Direct Known Subclasses:
ControllerDescriptor, DefaultTextDescriptor, RenderStateDescriptor, SpatialDescriptor

public abstract class A_TextDescriptor
extends java.lang.Object

Defines the basic functionality for creating descriptors.

Author:
Carter

Field Summary
protected  java.text.DecimalFormat decimal
          A decimal formatter
 
Constructor Summary
A_TextDescriptor()
           
 
Method Summary
protected  void clearDocument(javax.swing.text.StyledDocument infoDocument)
          Erases all text from the document.
protected  java.lang.String toString(Vector3f vector)
          Convenience method for converting a vector to a string.
abstract  void updateInfo(javax.swing.text.StyledDocument infoDocument, java.lang.Object object)
          Called when the text should be replaced with more current information.
protected  void writeString(javax.swing.text.StyledDocument infoDocument, java.lang.String string, java.lang.String style)
          Writes a string to the document.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

decimal

protected java.text.DecimalFormat decimal
A decimal formatter

Constructor Detail

A_TextDescriptor

public A_TextDescriptor()
Method Detail

clearDocument

protected final void clearDocument(javax.swing.text.StyledDocument infoDocument)
                            throws javax.swing.text.BadLocationException
Erases all text from the document.

Parameters:
infoDocument -
Throws:
javax.swing.text.BadLocationException

writeString

protected final void writeString(javax.swing.text.StyledDocument infoDocument,
                                 java.lang.String string,
                                 java.lang.String style)
                          throws javax.swing.text.BadLocationException
Writes a string to the document.

Parameters:
infoDocument -
string -
style -
Throws:
javax.swing.text.BadLocationException

updateInfo

public abstract void updateInfo(javax.swing.text.StyledDocument infoDocument,
                                java.lang.Object object)
Called when the text should be replaced with more current information.

Parameters:
infoDocument -
object -

toString

protected java.lang.String toString(Vector3f vector)
Convenience method for converting a vector to a string.

Parameters:
vector -
Returns: