LineFormat (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.FillFormat
- - com.aspose.cells.LineFormat

public class LineFormat
extends FillFormat

Represents all setting of the line.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         ShapeCollection shapes = workbook.getWorksheets().get(0).getShapes();
         Shape shape = shapes.addRectangle(1, 0, 1, 0, 50, 100);
         LineFormat lineFmt = shape.getLine();
 
         //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 `LineFormat` object.
`int`	`getBeginArrowheadLength()` Gets the begin arrow length type of the line.
`int`	`getBeginArrowheadStyle()` Gets the begin arrow type of the line.
`int`	`getBeginArrowheadWidth()` Gets the begin arrow width type of the line.
`int`	`getCapType()` Specifies the ending caps.
`int`	`getCompoundType()` Specifies the line compound type.
`int`	`getDashStyle()` Specifies the line dash type.
`int`	`getEndArrowheadLength()` Gets the end arrow length type of the line.
`int`	`getEndArrowheadStyle()` Gets the end arrow type of the line.
`int`	`getEndArrowheadWidth()` Gets the end arrow width type of the line.
`int`	`getJoinType()` Specifies the line join type.
`double`	`getWeight()` Gets the weight of the line in unit of points.
`int`	`hashCode()` Gets the hash code.
`void`	`setBeginArrowheadLength(int value)` Sets the begin arrow length type of the line.
`void`	`setBeginArrowheadStyle(int value)` Sets the begin arrow type of the line.
`void`	`setBeginArrowheadWidth(int value)` Sets the begin arrow width type of the line.
`void`	`setCapType(int value)` Specifies the ending caps.
`void`	`setCompoundType(int value)` Specifies the line compound type.
`void`	`setDashStyle(int value)` Specifies the line dash type.
`void`	`setEndArrowheadLength(int value)` Sets the end arrow length type of the line.
`void`	`setEndArrowheadStyle(int value)` Sets the end arrow type of the line.
`void`	`setEndArrowheadWidth(int value)` Sets the end arrow width type of the line.
`void`	`setJoinType(int value)` Specifies the line join type.
`void`	`setWeight(double value)` Sets the weight of the line in unit of points.

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

- Method Detail
  - hashCode
```
public int hashCode()
```
    Gets the hash code.
    Example
```
 
         int hashCode = lineFmt.hashCode();
 
```
    Overrides:
    
    hashCode in class FillFormat
    
    Returns:
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Determines whether this instance has the same value as another specified LineFormat object.
    Example
```
 
         //You have to make sure that the index value in this line of code exists
         LineFormat obj = workbook.getWorksheets().get(0).getShapes().get(0).getLine();
         if (lineFmt.equals(obj))
         {
             //do what you want
         }
 
```
    Overrides:
    
    equals in class FillFormat
    
    Parameters:
    obj - The LineFormat 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.
  - getCompoundType
```
public int getCompoundType()
```
    Specifies the line compound type.
    See MsoLineStyle.
    
    Example
```
 
         lineFmt.setCompoundType(MsoLineStyle.SINGLE);
 
```
  - setCompoundType
```
public void setCompoundType(int value)
```
    Specifies the line compound type.
    See MsoLineStyle.
  - getDashStyle
```
public int getDashStyle()
```
    Specifies the line dash type.
    See MsoLineDashStyle.
    
    Example
```
 
         lineFmt.setDashStyle(MsoLineDashStyle.SOLID);
 
```
  - setDashStyle
```
public void setDashStyle(int value)
```
    Specifies the line dash type.
    See MsoLineDashStyle.
  - getCapType
```
public int getCapType()
```
    Specifies the ending caps.
    See LineCapType.
    
    Example
```
 
         lineFmt.setCapType(LineCapType.FLAT);
 
```
  - setCapType
```
public void setCapType(int value)
```
    Specifies the ending caps.
    See LineCapType.
  - getJoinType
```
public int getJoinType()
```
    Specifies the line join type.
    See LineJoinType.
    
    Example
```
 
         lineFmt.setJoinType(LineJoinType.ROUND);
 
```
  - setJoinType
```
public void setJoinType(int value)
```
    Specifies the line join type.
    See LineJoinType.
  - getBeginArrowheadStyle
```
public int getBeginArrowheadStyle()
```
    Gets the begin arrow type of the line.
    See MsoArrowheadStyle.
    
    Example
```
 
         lineFmt.setBeginArrowheadStyle(MsoArrowheadStyle.ARROW_OPEN);
 
```
  - setBeginArrowheadStyle
```
public void setBeginArrowheadStyle(int value)
```
    Sets the begin arrow type of the line.
    See MsoArrowheadStyle.
  - getBeginArrowheadWidth
```
public int getBeginArrowheadWidth()
```
    Gets the begin arrow width type of the line.
    See MsoArrowheadWidth.
    
    Example
```
 
         lineFmt.setBeginArrowheadWidth(MsoArrowheadWidth.MEDIUM);
 
```
  - setBeginArrowheadWidth
```
public void setBeginArrowheadWidth(int value)
```
    Sets the begin arrow width type of the line.
    See MsoArrowheadWidth.
  - getBeginArrowheadLength
```
public int getBeginArrowheadLength()
```
    Gets the begin arrow length type of the line.
    See MsoArrowheadLength.
    
    Example
```
 
         lineFmt.setBeginArrowheadLength(MsoArrowheadLength.LONG);
 
```
  - setBeginArrowheadLength
```
public void setBeginArrowheadLength(int value)
```
    Sets the begin arrow length type of the line.
    See MsoArrowheadLength.
  - getEndArrowheadStyle
```
public int getEndArrowheadStyle()
```
    Gets the end arrow type of the line.
    See MsoArrowheadStyle.
    
    Example
```
 
         lineFmt.setEndArrowheadStyle(MsoArrowheadStyle.ARROW_OPEN);
 
```
  - setEndArrowheadStyle
```
public void setEndArrowheadStyle(int value)
```
    Sets the end arrow type of the line.
    See MsoArrowheadStyle.
  - getEndArrowheadWidth
```
public int getEndArrowheadWidth()
```
    Gets the end arrow width type of the line.
    See MsoArrowheadWidth.
    
    Example
```
 
         lineFmt.setEndArrowheadWidth(MsoArrowheadWidth.MEDIUM);
 
```
  - setEndArrowheadWidth
```
public void setEndArrowheadWidth(int value)
```
    Sets the end arrow width type of the line.
    See MsoArrowheadWidth.
  - getEndArrowheadLength
```
public int getEndArrowheadLength()
```
    Gets the end arrow length type of the line.
    See MsoArrowheadLength.
    
    Example
```
 
         lineFmt.setEndArrowheadLength(MsoArrowheadLength.LONG);
 
```
  - setEndArrowheadLength
```
public void setEndArrowheadLength(int value)
```
    Sets the end arrow length type of the line.
    See MsoArrowheadLength.
  - getWeight
```
public double getWeight()
```
    Gets the weight of the line in unit of points.
    Example
```
 
         lineFmt.setWeight(2.0d);
 
```
  - setWeight
```
public void setWeight(double value)
```
    Sets the weight of the line in unit of points.

Class LineFormat

Method Summary

Methods inherited from class com.aspose.cells.FillFormat

Methods inherited from class java.lang.Object

Method Detail

hashCode

equals

getCompoundType

setCompoundType

getDashStyle

setDashStyle

getCapType

setCapType

getJoinType

setJoinType

getBeginArrowheadStyle

setBeginArrowheadStyle

getBeginArrowheadWidth

setBeginArrowheadWidth

getBeginArrowheadLength

setBeginArrowheadLength

getEndArrowheadStyle

setEndArrowheadStyle

getEndArrowheadWidth

setEndArrowheadWidth

getEndArrowheadLength

setEndArrowheadLength

getWeight

setWeight