vtk
Class vtkTextProperty

java.lang.Object
  extended byvtk.vtkObjectBase
      extended byvtk.vtkObject
          extended byvtk.vtkTextProperty
All Implemented Interfaces:
java.io.Serializable

public class vtkTextProperty
extends vtkObject
implements java.io.Serializable

vtkTextProperty - represent text properties.. vtkTextProperty is an object that represents text properties. The primary properties that can be set are color, opacity, font size, font family horizontal and vertical justification, bold/italic/shadow styles. JavaBean wrapper for vtkTextProperty object.

Author:
vtk2jbean Automatic JavaBean wrapper for VTK.
See Also:
vtkTextMapper, vtkTextActor, vtkLegendBoxActor, Serialized Form

Field Summary
protected  java.beans.PropertyChangeSupport changes
           
 
Fields inherited from class vtk.vtkObjectBase
vtkId
 
Constructor Summary
  vtkTextProperty()
           
protected vtkTextProperty(int dmy)
           
 
Method Summary
 void antiAliasingOff()
          Enable/disable the local aliasing hint.
 void antiAliasingOn()
          Enable/disable the local aliasing hint.
 void boldOff()
          Enable/disable text bolding.
 void boldOn()
          Enable/disable text bolding.
 int getAntiAliasing()
          Enable/disable the local aliasing hint.
 int getBold()
          Enable/disable text bolding.
 java.lang.String getClassName()
          Return the class name as a string.
 double[] getColor()
          Set the color of the text..
 java.lang.String getFaceFileName()
          Specify a face file name (unsupported feature).
 int getFontFamily()
          Set/Get the font family.
 java.lang.String getFontFamilyAsString()
          Set/Get the font family.
 int getFontFamilyMaxValue()
          Set/Get the font family.
 int getFontFamilyMinValue()
          Set/Get the font family.
 int getFontSize()
          Set/Get the font size.
 int getFontSizeMaxValue()
          Set/Get the font size.
 int getFontSizeMinValue()
          Set/Get the font size.
 int getGlobalAntiAliasing()
          Set/Get the global antialiasing hint.
 int getItalic()
          Enable/disable text italic.
 int getJustification()
          Set/Get the horizontal justification to left (default), centered, or right.
 java.lang.String getJustificationAsString()
          Set/Get the horizontal justification to left (default), centered, or right.
 int getJustificationMaxValue()
          Set/Get the horizontal justification to left (default), centered, or right.
 int getJustificationMinValue()
          Set/Get the horizontal justification to left (default), centered, or right.
 double getLineOffset()
          These methods can be used to control the spacing and placement of text (in the vertical direction).
 double getLineSpacing()
          These methods can be used to control the spacing and placement of text (in the vertical direction).
 double getOpacity()
          Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent.
 int getShadow()
          Enable/disable text shadows.
 vtkTextProperty getThisTextProperty()
           
 int getVerticalJustification()
          Set/Get the vertical justification to bottom (default), middle, or top.
 java.lang.String getVerticalJustificationAsString()
          Set/Get the vertical justification to bottom (default), middle, or top.
 int getVerticalJustificationMaxValue()
          Set/Get the vertical justification to bottom (default), middle, or top.
 int getVerticalJustificationMinValue()
          Set/Get the vertical justification to bottom (default), middle, or top.
 int isA(java.lang.String id0)
          Return 1 if this class is the same type of (or a subclass of) the named class.
 void italicOff()
          Enable/disable text italic.
 void italicOn()
          Enable/disable text italic.
 void setAntiAliasing(int id0)
          Enable/disable the local aliasing hint.
 void setBold(int id0)
          Enable/disable text bolding.
 void setColor(double[] id0)
          Set the color of the text..
 void setColor(double id0, double id1, double id2)
          Set the color of the text..
 void setFaceFileName(java.lang.String id0)
          Specify a face file name (unsupported feature).
 void setFontFamily(int id0)
          Set/Get the font family.
 void setFontFamilyToArial()
          Set/Get the font family.
 void setFontFamilyToCourier()
          Set/Get the font family.
 void setFontFamilyToTimes()
          Set/Get the font family.
 void setFontSize(int id0)
          Set/Get the font size.
 void setGlobalAntiAliasing(int id0)
          Set/Get the global antialiasing hint.
 void setGlobalAntiAliasingToAll()
          Set/Get the global antialiasing hint.
 void setGlobalAntiAliasingToNone()
          Set/Get the global antialiasing hint.
 void setGlobalAntiAliasingToSome()
          Set/Get the global antialiasing hint.
 void setItalic(int id0)
          Enable/disable text italic.
 void setJustification(int id0)
          Set/Get the horizontal justification to left (default), centered, or right.
 void setJustificationToCentered()
          Set/Get the horizontal justification to left (default), centered, or right.
 void setJustificationToLeft()
          Set/Get the horizontal justification to left (default), centered, or right.
 void setJustificationToRight()
          Set/Get the horizontal justification to left (default), centered, or right.
 void setLineOffset(double id0)
          These methods can be used to control the spacing and placement of text (in the vertical direction).
 void setLineSpacing(double id0)
          These methods can be used to control the spacing and placement of text (in the vertical direction).
 void setOpacity(double id0)
          Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent.
 void setShadow(int id0)
          Enable/disable text shadows.
 void setVerticalJustification(int id0)
          Set/Get the vertical justification to bottom (default), middle, or top.
 void setVerticalJustificationToBottom()
          Set/Get the vertical justification to bottom (default), middle, or top.
 void setVerticalJustificationToCentered()
          Set/Get the vertical justification to bottom (default), middle, or top.
 void setVerticalJustificationToTop()
          Set/Get the vertical justification to bottom (default), middle, or top.
 void shadowOff()
          Enable/disable text shadows.
 void shadowOn()
          Enable/disable text shadows.
 void shallowCopy(vtkTextProperty id0)
          Shallow copy of a text property.
protected  void VTKCastInit()
           
 void VTKInit()
           
 
Methods inherited from class vtk.vtkObject
AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getMTime, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay, unRegister
 
Methods inherited from class vtk.vtkObjectBase
addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

changes

protected java.beans.PropertyChangeSupport changes
Constructor Detail

vtkTextProperty

public vtkTextProperty()

vtkTextProperty

protected vtkTextProperty(int dmy)
Method Detail

getThisTextProperty

public vtkTextProperty getThisTextProperty()

getClassName

public java.lang.String getClassName()
Description copied from class: vtkObjectBase
Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
getClassName in class vtkObject

isA

public int isA(java.lang.String id0)
Description copied from class: vtkObjectBase
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
isA in class vtkObject

setColor

public void setColor(double id0,
                     double id1,
                     double id2)
Set the color of the text..


setColor

public void setColor(double[] id0)
Set the color of the text..


getColor

public double[] getColor()
Set the color of the text..


setOpacity

public void setOpacity(double id0)
Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent.


getOpacity

public double getOpacity()
Set/Get the text's opacity. 1.0 is totally opaque and 0.0 is completely transparent.


setFontFamily

public void setFontFamily(int id0)
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


getFontFamilyMinValue

public int getFontFamilyMinValue()
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


getFontFamilyMaxValue

public int getFontFamilyMaxValue()
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


getFontFamily

public int getFontFamily()
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


setFontFamilyToArial

public void setFontFamilyToArial()
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


setFontFamilyToCourier

public void setFontFamilyToCourier()
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


setFontFamilyToTimes

public void setFontFamilyToTimes()
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


getFontFamilyAsString

public java.lang.String getFontFamilyAsString()
Set/Get the font family. Three font types are allowed: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).


setFontSize

public void setFontSize(int id0)
Set/Get the font size.


getFontSizeMinValue

public int getFontSizeMinValue()
Set/Get the font size.


getFontSizeMaxValue

public int getFontSizeMaxValue()
Set/Get the font size.


getFontSize

public int getFontSize()
Set/Get the font size.


setBold

public void setBold(int id0)
Enable/disable text bolding.


getBold

public int getBold()
Enable/disable text bolding.


boldOn

public void boldOn()
Enable/disable text bolding.


boldOff

public void boldOff()
Enable/disable text bolding.


setItalic

public void setItalic(int id0)
Enable/disable text italic.


getItalic

public int getItalic()
Enable/disable text italic.


italicOn

public void italicOn()
Enable/disable text italic.


italicOff

public void italicOff()
Enable/disable text italic.


setShadow

public void setShadow(int id0)
Enable/disable text shadows.


getShadow

public int getShadow()
Enable/disable text shadows.


shadowOn

public void shadowOn()
Enable/disable text shadows.


shadowOff

public void shadowOff()
Enable/disable text shadows.


setAntiAliasing

public void setAntiAliasing(int id0)
Enable/disable the local aliasing hint.


getAntiAliasing

public int getAntiAliasing()
Enable/disable the local aliasing hint.


antiAliasingOn

public void antiAliasingOn()
Enable/disable the local aliasing hint.


antiAliasingOff

public void antiAliasingOff()
Enable/disable the local aliasing hint.


getGlobalAntiAliasing

public int getGlobalAntiAliasing()
Set/Get the global antialiasing hint. Control whether to *globally* force text antialiasing (ALL), disable antialiasing (NONE) or allow antialising depending on the per-object AntiAliasing attribute (SOME).


setGlobalAntiAliasing

public void setGlobalAntiAliasing(int id0)
Set/Get the global antialiasing hint. Control whether to *globally* force text antialiasing (ALL), disable antialiasing (NONE) or allow antialising depending on the per-object AntiAliasing attribute (SOME).


setGlobalAntiAliasingToSome

public void setGlobalAntiAliasingToSome()
Set/Get the global antialiasing hint. Control whether to *globally* force text antialiasing (ALL), disable antialiasing (NONE) or allow antialising depending on the per-object AntiAliasing attribute (SOME).


setGlobalAntiAliasingToNone

public void setGlobalAntiAliasingToNone()
Set/Get the global antialiasing hint. Control whether to *globally* force text antialiasing (ALL), disable antialiasing (NONE) or allow antialising depending on the per-object AntiAliasing attribute (SOME).


setGlobalAntiAliasingToAll

public void setGlobalAntiAliasingToAll()
Set/Get the global antialiasing hint. Control whether to *globally* force text antialiasing (ALL), disable antialiasing (NONE) or allow antialising depending on the per-object AntiAliasing attribute (SOME).


setJustification

public void setJustification(int id0)
Set/Get the horizontal justification to left (default), centered, or right.


getJustificationMinValue

public int getJustificationMinValue()
Set/Get the horizontal justification to left (default), centered, or right.


getJustificationMaxValue

public int getJustificationMaxValue()
Set/Get the horizontal justification to left (default), centered, or right.


getJustification

public int getJustification()
Set/Get the horizontal justification to left (default), centered, or right.


setJustificationToLeft

public void setJustificationToLeft()
Set/Get the horizontal justification to left (default), centered, or right.


setJustificationToCentered

public void setJustificationToCentered()
Set/Get the horizontal justification to left (default), centered, or right.


setJustificationToRight

public void setJustificationToRight()
Set/Get the horizontal justification to left (default), centered, or right.


getJustificationAsString

public java.lang.String getJustificationAsString()
Set/Get the horizontal justification to left (default), centered, or right.


setVerticalJustification

public void setVerticalJustification(int id0)
Set/Get the vertical justification to bottom (default), middle, or top.


getVerticalJustificationMinValue

public int getVerticalJustificationMinValue()
Set/Get the vertical justification to bottom (default), middle, or top.


getVerticalJustificationMaxValue

public int getVerticalJustificationMaxValue()
Set/Get the vertical justification to bottom (default), middle, or top.


getVerticalJustification

public int getVerticalJustification()
Set/Get the vertical justification to bottom (default), middle, or top.


setVerticalJustificationToBottom

public void setVerticalJustificationToBottom()
Set/Get the vertical justification to bottom (default), middle, or top.


setVerticalJustificationToCentered

public void setVerticalJustificationToCentered()
Set/Get the vertical justification to bottom (default), middle, or top.


setVerticalJustificationToTop

public void setVerticalJustificationToTop()
Set/Get the vertical justification to bottom (default), middle, or top.


getVerticalJustificationAsString

public java.lang.String getVerticalJustificationAsString()
Set/Get the vertical justification to bottom (default), middle, or top.


setLineOffset

public void setLineOffset(double id0)
These methods can be used to control the spacing and placement of text (in the vertical direction). LineOffset is a vertical offset (measured in pixels); LineSpacing is the spacing between lines, expressed as a text height multiplication factor.


getLineOffset

public double getLineOffset()
These methods can be used to control the spacing and placement of text (in the vertical direction). LineOffset is a vertical offset (measured in pixels); LineSpacing is the spacing between lines, expressed as a text height multiplication factor.


setLineSpacing

public void setLineSpacing(double id0)
These methods can be used to control the spacing and placement of text (in the vertical direction). LineOffset is a vertical offset (measured in pixels); LineSpacing is the spacing between lines, expressed as a text height multiplication factor.


getLineSpacing

public double getLineSpacing()
These methods can be used to control the spacing and placement of text (in the vertical direction). LineOffset is a vertical offset (measured in pixels); LineSpacing is the spacing between lines, expressed as a text height multiplication factor.


shallowCopy

public void shallowCopy(vtkTextProperty id0)
Shallow copy of a text property.


setFaceFileName

public void setFaceFileName(java.lang.String id0)
Specify a face file name (unsupported feature). A face filename will override the font family as well as the bold and italic attributes.


getFaceFileName

public java.lang.String getFaceFileName()
Specify a face file name (unsupported feature). A face filename will override the font family as well as the bold and italic attributes.


VTKInit

public void VTKInit()
Overrides:
VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()
Overrides:
VTKCastInit in class vtkObject


Copyright © 2004 Sydney ViSLAB. All Rights Reserved.