ShapeTextAlignment (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.ShapeTextAlignment

public class ShapeTextAlignment
extends java.lang.Object

Represents the setting of shape's text alignment;

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Shape shape = workbook.getWorksheets().get(0).getShapes().addRectangle(1, 0, 1, 0, 50, 100);
         ShapeTextAlignment shapeTextAlignment = shape.getTextBody().getTextAlignment();
 
         //do your business

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Determines whether this instance has the same value as another specified `ShapeTextAlignment` object.
`boolean`	`getAutoSize()` Indicates if size of shape is adjusted automatically according to its content.
`double`	`getBottomMarginPt()` Returns the bottom margin in unit of Points
`double`	`getLeftMarginPt()` Returns the left margin in unit of Points
`int`	`getNumberOfColumns()` Gets the number of columns of text in the bounding rectangle.
`double`	`getRightMarginPt()` Returns the right margin in unit of Points
`boolean`	`getRotateTextWithShape()` Indicates whether rotating text with shape.
`double`	`getRotationAngle()` Gets the rotation of the shape.
`int`	`getTextHorizontalOverflow()` Gets the text horizontal overflow type of the text box.
`int`	`getTextShapeType()` Gets the transform type of text.
`int`	`getTextVerticalOverflow()` Gets the text vertical overflow type of the text box.
`int`	`getTextVerticalType()` Gets the text direction.
`double`	`getTopMarginPt()` Returns the top margin in unit of Points
`int`	`hashCode()`
`boolean`	`isAutoMargin()` Indicates whether the margin of the text frame is automatic.
`boolean`	`isLockedText()` Indicates whether the shape is locked when worksheet is protected.
`boolean`	`isTextWrapped()` Gets the text wrapped type of the shape which contains text.
`void`	`setAutoMargin(boolean value)` Indicates whether the margin of the text frame is automatic.
`void`	`setAutoSize(boolean value)` Indicates if size of shape is adjusted automatically according to its content.
`void`	`setBottomMarginPt(double value)` Returns the bottom margin in unit of Points
`void`	`setLeftMarginPt(double value)` Returns the left margin in unit of Points
`void`	`setLockedText(boolean value)` Indicates whether the shape is locked when worksheet is protected.
`void`	`setNumberOfColumns(int value)` Sets the number of columns of text in the bounding rectangle.
`void`	`setRightMarginPt(double value)` Returns the right margin in unit of Points
`void`	`setRotateTextWithShape(boolean value)` Indicates whether rotating text with shape.
`void`	`setRotationAngle(double value)` Sets the rotation of the shape.
`void`	`setTextHorizontalOverflow(int value)` Sets the text horizontal overflow type of the text box.
`void`	`setTextShapeType(int value)` Sets the transform type of text.
`void`	`setTextVerticalOverflow(int value)` Sets the text vertical overflow type of the text box.
`void`	`setTextVerticalType(int value)` Sets the text direction.
`void`	`setTextWrapped(boolean value)` Sets the text wrapped type of the shape which contains text.
`void`	`setTopMarginPt(double value)` Returns the top margin in unit of Points

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isTextWrapped
```
public boolean isTextWrapped()
```
    Gets the text wrapped type of the shape which contains text.
    Example
```
 
         shapeTextAlignment.setTextWrapped(true);
 
```
  - setTextWrapped
```
public void setTextWrapped(boolean value)
```
    Sets the text wrapped type of the shape which contains text.
  - getRotateTextWithShape
```
public boolean getRotateTextWithShape()
```
    Indicates whether rotating text with shape.
    Example
```
 
         shapeTextAlignment.setRotateTextWithShape(true);
 
```
  - setRotateTextWithShape
```
public void setRotateTextWithShape(boolean value)
```
    Indicates whether rotating text with shape.
  - getTextVerticalOverflow
```
public int getTextVerticalOverflow()
```
    Gets the text vertical overflow type of the text box.
    See TextOverflowType.
    
    Example
```
 
         shapeTextAlignment.setTextVerticalOverflow(TextOverflowType.CLIP);
 
```
  - setTextVerticalOverflow
```
public void setTextVerticalOverflow(int value)
```
    Sets the text vertical overflow type of the text box.
    See TextOverflowType.
  - getTextHorizontalOverflow
```
public int getTextHorizontalOverflow()
```
    Gets the text horizontal overflow type of the text box.
    See TextOverflowType.
    
    Example
```
 
         shapeTextAlignment.setTextHorizontalOverflow(TextOverflowType.CLIP);
 
```
  - setTextHorizontalOverflow
```
public void setTextHorizontalOverflow(int value)
```
    Sets the text horizontal overflow type of the text box.
    See TextOverflowType.
  - getRotationAngle
```
public double getRotationAngle()
```
    Gets the rotation of the shape.
    Example
```
 
         shapeTextAlignment.setRotationAngle(90);
 
```
  - setRotationAngle
```
public void setRotationAngle(double value)
```
    Sets the rotation of the shape.
  - getTextVerticalType
```
public int getTextVerticalType()
```
    Gets the text direction.
    See TextVerticalType.
    
    Example
```
 
         shapeTextAlignment.setTextVerticalType(com.aspose.cells.TextVerticalType.HORIZONTAL);
 
```
  - setTextVerticalType
```
public void setTextVerticalType(int value)
```
    Sets the text direction.
    See TextVerticalType.
  - isLockedText
```
public boolean isLockedText()
```
    Indicates whether the shape is locked when worksheet is protected.
    Remarks
    Only works when worksheet is protected.
  - setLockedText
```
public void setLockedText(boolean value)
```
    Indicates whether the shape is locked when worksheet is protected.
    Remarks
    Only works when worksheet is protected.
  - getAutoSize
```
public boolean getAutoSize()
```
    Indicates if size of shape is adjusted automatically according to its content.
    Example
```
 
         shapeTextAlignment.setAutoSize(false);
 
```
  - setAutoSize
```
public void setAutoSize(boolean value)
```
    Indicates if size of shape is adjusted automatically according to its content.
  - getTextShapeType
```
public int getTextShapeType()
```
    Gets the transform type of text.
    See AutoShapeType.
    
    Example
```
 
         //Usually do not modify this value unless you know exactly what the modification will result in
         shapeTextAlignment.setTextShapeType(AutoShapeType.TEXT_BOX);
 
```
  - setTextShapeType
```
public void setTextShapeType(int value)
```
    Sets the transform type of text.
    See AutoShapeType.
  - getTopMarginPt
```
public double getTopMarginPt()
```
    Returns the top margin in unit of Points
    Example
```
 
         shapeTextAlignment.setTopMarginPt(2.0d);
 
```
  - setTopMarginPt
```
public void setTopMarginPt(double value)
```
    Returns the top margin in unit of Points
  - getBottomMarginPt
```
public double getBottomMarginPt()
```
    Returns the bottom margin in unit of Points
    Example
```
 
         shapeTextAlignment.setBottomMarginPt(2.0d);
 
```
  - setBottomMarginPt
```
public void setBottomMarginPt(double value)
```
    Returns the bottom margin in unit of Points
  - getLeftMarginPt
```
public double getLeftMarginPt()
```
    Returns the left margin in unit of Points
    Example
```
 
         shapeTextAlignment.setLeftMarginPt(2.0d);
 
```
  - setLeftMarginPt
```
public void setLeftMarginPt(double value)
```
    Returns the left margin in unit of Points
  - getRightMarginPt
```
public double getRightMarginPt()
```
    Returns the right margin in unit of Points
    Example
```
 
         shapeTextAlignment.setRightMarginPt(2.0d);
 
```
  - setRightMarginPt
```
public void setRightMarginPt(double value)
```
    Returns the right margin in unit of Points
  - isAutoMargin
```
public boolean isAutoMargin()
```
    Indicates whether the margin of the text frame is automatic.
    Example
```
 
         shapeTextAlignment.setAutoMargin(true);
 
```
  - setAutoMargin
```
public void setAutoMargin(boolean value)
```
    Indicates whether the margin of the text frame is automatic.
  - getNumberOfColumns
```
public int getNumberOfColumns()
```
    Gets the number of columns of text in the bounding rectangle.
  - setNumberOfColumns
```
public void setNumberOfColumns(int value)
```
    Sets the number of columns of text in the bounding rectangle.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Determines whether this instance has the same value as another specified ShapeTextAlignment object.
    Example
```
 
         //You have to make sure that the index value in this line of code exists
         ShapeTextAlignment obj = workbook.getWorksheets().get(0).getShapes().get(0).getTextBody().getTextAlignment();
         if (shapeTextAlignment.equals(obj))
         {
             //do what you want
         }
 
```
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - The ShapeTextAlignment object to compare with this instance.
    
    Returns:
    true if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:

Class ShapeTextAlignment

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isTextWrapped

setTextWrapped

getRotateTextWithShape

setRotateTextWithShape

getTextVerticalOverflow

setTextVerticalOverflow

getTextHorizontalOverflow

setTextHorizontalOverflow

getRotationAngle

setRotationAngle

getTextVerticalType

setTextVerticalType

isLockedText

setLockedText

getAutoSize

setAutoSize

getTextShapeType

setTextShapeType

getTopMarginPt

setTopMarginPt

getBottomMarginPt

setBottomMarginPt

getLeftMarginPt

setLeftMarginPt

getRightMarginPt

setRightMarginPt

isAutoMargin

setAutoMargin

getNumberOfColumns

setNumberOfColumns

equals

hashCode