com.aspose.barcode
Class Caption

java.lang.Object
  extended by com.aspose.barcode.Caption

The text caption shown in the com.aspose.barcode image. There are two captions: CaptionBelow and CaptionAbove


Constructor Summary
Caption()
          
Method Summary
 Caption copy()
          
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Caption

public Caption()

Initialize an instance of Captioncaption class with default vaule.


Caption

public Caption(java.lang.String text)

Initialize an instance of Captioncaption class with specified text.

Parameters:
text - The text content of the caption object

Caption

public Caption(java.lang.String text,
               boolean visible,
               int alignment,
               float space,
               java.awt.Color color,
               Font font)
Method Detail

copy

public Caption copy()

Get a new copy of the caption instance.

Returns:
The new copy of the instance.

dispose

public void dispose()

Dispose the Caption instance


getFont

public Font getFont()

Gets or sets the System.Drawing.Fontfont of the Captioncaption.


getForeColor

public java.awt.Color getForeColor()

Gets the System.Drawing.Colorforecolor of the Captioncaption.


getSpace

public float getSpace()

Gets the space between the Aspose.BarCode.Captioncaption and the com.aspose.barcode, and the space between border and the caption

Throws:
ArgumentException - <p>The <b>Space</b> parameter value is less than 0.</p>


The measure unit of the <b>space</b> for the caption is indicated by the System.Drawing.GraphicsUnitGraphicsUnit.


getText

public java.lang.String getText()

Gets the content of the Aspose.BarCode.Captioncaption.


getTextAlign

public int getTextAlign()

Gets the text System.Drawing.StringAlignmentalignment of the Aspose.BarCode.Captioncaption. e.g. when the text is writing from left to right, StringAlignment.Near means the Caption will be aligned to the left


getVisible

public boolean getVisible()

Gets a value indicates whether the Captioncaption is visible.


setFont

public void setFont(Font value)

setForeColor

public void setForeColor(java.awt.Color value)

Sets the System.Drawing.Colorforecolor of the Captioncaption.


setSpace

public void setSpace(float value)

Sets the space between the Aspose.BarCode.Captioncaption and the com.aspose.barcode, and the space between border and the caption

Throws:
ArgumentException - <p>The <b>Space</b> parameter value is less than 0.</p>


The measure unit of the <b>space</b> for the caption is indicated by the System.Drawing.GraphicsUnitGraphicsUnit.


setText

public void setText(java.lang.String value)

Sets the content of the Aspose.BarCode.Captioncaption.


setTextAlign

public void setTextAlign(int value)

Sets the text System.Drawing.StringAlignmentalignment of the Aspose.BarCode.Captioncaption. e.g. when the text is writing from left to right, StringAlignment.Near means the Caption will be aligned to the left


setVisible

public void setVisible(boolean value)

Sets a value indicates whether the Captioncaption is visible.