Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Aspose.Tasks for Java API reference to v.24.9. #75

Merged
merged 2 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions english/java/com.aspose.tasks/barshape/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ Shape of a bar rectangle.
| Field | Description |
| --- | --- |
| [Full](#Full) | Indicates Full rectangle bar shape. |
| [HalfHeight](#HalfHeight) | Indicates Half height rectangle bar shape. |
| [LineBottom](#LineBottom) | Indicates Line bottom bar shape. |
| [Middle](#Middle) | Indicates Rectangle middle bar shape. |
| [HalfHeight](#HalfHeight) | Indicates top-aligned half height rectangle bar shape. |
| [HalfHeightBottom](#HalfHeightBottom) | Indicates bottom-aligned half height rectangle bar shape. |
| [LineBottom](#LineBottom) | Indicates bottom-aligned line shape. |
| [LineTop](#LineTop) | Indicates top-aligned line shape. |
| [Middle](#Middle) | Indicates center-aligned line shape. |
| [None](#None) | Indicates None bar shape. |
| [Thin](#Thin) | Indicates Thin rectangle bar shape. |
| [Thin](#Thin) | Indicates center-aligned line shape. |
### Full {#Full}
```
public static final int Full
Expand All @@ -38,23 +40,39 @@ public static final int HalfHeight
```


Indicates Half height rectangle bar shape.
Indicates top-aligned half height rectangle bar shape.

### HalfHeightBottom {#HalfHeightBottom}
```
public static final int HalfHeightBottom
```


Indicates bottom-aligned half height rectangle bar shape.

### LineBottom {#LineBottom}
```
public static final int LineBottom
```


Indicates Line bottom bar shape.
Indicates bottom-aligned line shape.

### LineTop {#LineTop}
```
public static final int LineTop
```


Indicates top-aligned line shape.

### Middle {#Middle}
```
public static final int Middle
```


Indicates Rectangle middle bar shape.
Indicates center-aligned line shape.

### None {#None}
```
Expand All @@ -70,5 +88,5 @@ public static final int Thin
```


Indicates Thin rectangle bar shape.
Indicates center-aligned line shape.

100 changes: 100 additions & 0 deletions english/java/com.aspose.tasks/barstyle/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Change the visual style of the bar for the item in the project view.
| [getBottomField()](#getBottomField--) | Gets a field to be displayed on the bottom of the bar. |
| [getEndShape()](#getEndShape--) | Gets [Shape](../../com.aspose.tasks/shape) at the end of the bar. |
| [getEndShapeColor()](#getEndShapeColor--) | Gets java.awt.Color of the shape at the end of the bar. |
| [getEndShapeType()](#getEndShapeType--) | Gets a type of the end shape. |
| [getFrom()](#getFrom--) | Gets a start point position of the gantt bar. |
| [getInsideBarTextConverter()](#getInsideBarTextConverter--) | Gets user-defined converter to get text to render inside of the task's bar. |
| [getInsideField()](#getInsideField--) | Gets a field to be displayed inside of the bar. |
| [getItemType()](#getItemType--) | Gets [BarItemType](../../com.aspose.tasks/baritemtype) of the bar style. |
Expand All @@ -38,7 +40,9 @@ Change the visual style of the bar for the item in the project view.
| [getRightField()](#getRightField--) | Gets a field to be displayed on the right of the bar. |
| [getStartShape()](#getStartShape--) | Gets [Shape](../../com.aspose.tasks/shape) at the beginning of the bar. |
| [getStartShapeColor()](#getStartShapeColor--) | Gets java.awt.Color of the shape at the beginning of the bar. |
| [getStartShapeType()](#getStartShapeType--) | Gets a type of the start shape. |
| [getTextStyle()](#getTextStyle--) | Gets style of the bar's text. |
| [getTo()](#getTo--) | Gets a finish point position of the gantt bar. |
| [getTopBarTextConverter()](#getTopBarTextConverter--) | Gets user-defined converter to get text to render on the top of the task's bar. |
| [getTopField()](#getTopField--) | Gets a field to be displayed on the top of the bar. |
| [setBarColor(Color value)](#setBarColor-java.awt.Color-) | Sets java.awt.Color of the bar style. |
Expand All @@ -47,6 +51,8 @@ Change the visual style of the bar for the item in the project view.
| [setBottomField(int value)](#setBottomField-int-) | Sets a field to be displayed on the bottom of the bar. |
| [setEndShape(int value)](#setEndShape-int-) | Sets [Shape](../../com.aspose.tasks/shape) at the end of the bar. |
| [setEndShapeColor(Color value)](#setEndShapeColor-java.awt.Color-) | Sets java.awt.Color of the shape at the end of the bar. |
| [setEndShapeType(int value)](#setEndShapeType-int-) | Sets a type of the end shape. |
| [setFrom(int value)](#setFrom-int-) | Sets a start point position of the gantt bar. |
| [setInsideBarTextConverter(TaskBarTextConverter value)](#setInsideBarTextConverter-com.aspose.tasks.TaskBarTextConverter-) | Sets user-defined converter to get text to render inside of the task's bar. |
| [setInsideField(int value)](#setInsideField-int-) | Sets a field to be displayed inside of the bar. |
| [setItemType(int value)](#setItemType-int-) | Sets [BarItemType](../../com.aspose.tasks/baritemtype) of the bar style. |
Expand All @@ -56,7 +62,9 @@ Change the visual style of the bar for the item in the project view.
| [setRightField(int value)](#setRightField-int-) | Sets a field to be displayed on the right of the bar. |
| [setStartShape(int value)](#setStartShape-int-) | Sets [Shape](../../com.aspose.tasks/shape) at the beginning of the bar. |
| [setStartShapeColor(Color value)](#setStartShapeColor-java.awt.Color-) | Sets java.awt.Color of the shape at the beginning of the bar. |
| [setStartShapeType(int value)](#setStartShapeType-int-) | Sets a type of the start shape. |
| [setTextStyle(TextStyle value)](#setTextStyle-com.aspose.tasks.TextStyle-) | Sets style of the bar's text. |
| [setTo(int value)](#setTo-int-) | Sets a finish point position of the gantt bar. |
| [setTopBarTextConverter(TaskBarTextConverter value)](#setTopBarTextConverter-com.aspose.tasks.TaskBarTextConverter-) | Sets user-defined converter to get text to render on the top of the task's bar. |
| [setTopField(int value)](#setTopField-int-) | Sets a field to be displayed on the top of the bar. |
### BarStyle() {#BarStyle--}
Expand Down Expand Up @@ -127,6 +135,26 @@ Gets java.awt.Color of the shape at the end of the bar.

**Returns:**
java.awt.Color - a color of the shape at the beginning of the bar.
### getEndShapeType() {#getEndShapeType--}
```
public final int getEndShapeType()
```


Gets a type of the end shape. [GanttBarType](../../com.aspose.tasks/ganttbartype).

**Returns:**
int - a type of the end shape.
### getFrom() {#getFrom--}
```
public final int getFrom()
```


Gets a start point position of the gantt bar. [Field](../../com.aspose.tasks/field).

**Returns:**
int - a start point position of the gantt bar.
### getInsideBarTextConverter() {#getInsideBarTextConverter--}
```
public final TaskBarTextConverter getInsideBarTextConverter()
Expand Down Expand Up @@ -217,6 +245,16 @@ Gets java.awt.Color of the shape at the beginning of the bar.

**Returns:**
java.awt.Color - a color of the shape at the beginning of the bar.
### getStartShapeType() {#getStartShapeType--}
```
public final int getStartShapeType()
```


Gets a type of the start shape.

**Returns:**
int - a type of the start shape.
### getTextStyle() {#getTextStyle--}
```
public final TextStyle getTextStyle()
Expand All @@ -227,6 +265,16 @@ Gets style of the bar's text.

**Returns:**
[TextStyle](../../com.aspose.tasks/textstyle) - style of the bar's text.
### getTo() {#getTo--}
```
public final int getTo()
```


Gets a finish point position of the gantt bar.

**Returns:**
int - a finish point position of the gantt bar.
### getTopBarTextConverter() {#getTopBarTextConverter--}
```
public final TaskBarTextConverter getTopBarTextConverter()
Expand Down Expand Up @@ -325,6 +373,32 @@ Sets java.awt.Color of the shape at the end of the bar.
| --- | --- | --- |
| value | java.awt.Color | a color of the shape at the beginning of the bar. |

### setEndShapeType(int value) {#setEndShapeType-int-}
```
public final void setEndShapeType(int value)
```


Sets a type of the end shape. [GanttBarType](../../com.aspose.tasks/ganttbartype).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | a type of the end shape. |

### setFrom(int value) {#setFrom-int-}
```
public final void setFrom(int value)
```


Sets a start point position of the gantt bar. [Field](../../com.aspose.tasks/field).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | a start point position of the gantt bar. |

### setInsideBarTextConverter(TaskBarTextConverter value) {#setInsideBarTextConverter-com.aspose.tasks.TaskBarTextConverter-}
```
public final void setInsideBarTextConverter(TaskBarTextConverter value)
Expand Down Expand Up @@ -442,6 +516,19 @@ Sets java.awt.Color of the shape at the beginning of the bar.
| --- | --- | --- |
| value | java.awt.Color | a color of the shape at the beginning of the bar. |

### setStartShapeType(int value) {#setStartShapeType-int-}
```
public final void setStartShapeType(int value)
```


Sets a type of the start shape.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | a type of the start shape. |

### setTextStyle(TextStyle value) {#setTextStyle-com.aspose.tasks.TextStyle-}
```
public final void setTextStyle(TextStyle value)
Expand All @@ -455,6 +542,19 @@ Sets style of the bar's text.
| --- | --- | --- |
| value | [TextStyle](../../com.aspose.tasks/textstyle) | style of the bar's text. |

### setTo(int value) {#setTo-int-}
```
public final void setTo(int value)
```


Sets a finish point position of the gantt bar.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | int | a finish point position of the gantt bar. |

### setTopBarTextConverter(TaskBarTextConverter value) {#setTopBarTextConverter-com.aspose.tasks.TaskBarTextConverter-}
```
public final void setTopBarTextConverter(TaskBarTextConverter value)
Expand Down
32 changes: 16 additions & 16 deletions english/java/com.aspose.tasks/ganttbarmiddleshape/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,75 +18,75 @@ Specifies the middle shape of a bar.

| Field | Description |
| --- | --- |
| [LineBottom](#LineBottom) | Indicates Bottom line Gantt bar middle shape. |
| [LineMiddle](#LineMiddle) | Indicates Middle line Gantt bar middle shape. |
| [LineTop](#LineTop) | Indicates Top line Gantt bar middle shape. |
| [None](#None) | Indicates None Gantt bar middle shape. |
| [RectangleBar](#RectangleBar) | Indicates Rectangle Gantt bar middle shape. |
| [RectangleBottom](#RectangleBottom) | Indicates Rectangle bottom Gantt bar middle shape. |
| [RectangleMiddle](#RectangleMiddle) | Indicates Rectangle middle Gantt bar middle shape. |
| [RectangleTop](#RectangleTop) | Indicates Rectangle top Gantt bar middle shape. |
| [LineBottom](#LineBottom) | Indicates bottom-aligned line shape. |
| [LineMiddle](#LineMiddle) | Indicates center-aligned line shape. |
| [LineTop](#LineTop) | Indicates top-aligned line shape. |
| [None](#None) | Indicates empty shape. |
| [RectangleBar](#RectangleBar) | Indicates full height rectangle bar shape. |
| [RectangleBottom](#RectangleBottom) | Indicates Indicates bottom-aligned half height rectangle bar shape. |
| [RectangleMiddle](#RectangleMiddle) | Indicates center-aligned 1/3 height rectangle bar shape. |
| [RectangleTop](#RectangleTop) | Indicates top-aligned half height rectangle bar shape. |
### LineBottom {#LineBottom}
```
public static final int LineBottom
```


Indicates Bottom line Gantt bar middle shape.
Indicates bottom-aligned line shape.

### LineMiddle {#LineMiddle}
```
public static final int LineMiddle
```


Indicates Middle line Gantt bar middle shape.
Indicates center-aligned line shape.

### LineTop {#LineTop}
```
public static final int LineTop
```


Indicates Top line Gantt bar middle shape.
Indicates top-aligned line shape.

### None {#None}
```
public static final int None
```


Indicates None Gantt bar middle shape.
Indicates empty shape.

### RectangleBar {#RectangleBar}
```
public static final int RectangleBar
```


Indicates Rectangle Gantt bar middle shape.
Indicates full height rectangle bar shape.

### RectangleBottom {#RectangleBottom}
```
public static final int RectangleBottom
```


Indicates Rectangle bottom Gantt bar middle shape.
Indicates Indicates bottom-aligned half height rectangle bar shape.

### RectangleMiddle {#RectangleMiddle}
```
public static final int RectangleMiddle
```


Indicates Rectangle middle Gantt bar middle shape.
Indicates center-aligned 1/3 height rectangle bar shape.

### RectangleTop {#RectangleTop}
```
public static final int RectangleTop
```


Indicates Rectangle top Gantt bar middle shape.
Indicates top-aligned half height rectangle bar shape.

9 changes: 9 additions & 0 deletions english/java/com.aspose.tasks/shape/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Shape of a marker at the beginning or end of the bar style to be rendered when s
| Field | Description |
| --- | --- |
| [ArrowDown](#ArrowDown) | Indicates ArrowDown shape. |
| [Circle](#Circle) | Indicates Circle shape. |
| [Diamond](#Diamond) | Indicates Diamond shape. |
| [LeftBracket](#LeftBracket) | Indicates Left bracket shape. |
| [LeftFade](#LeftFade) | Indicates Left fade shape. |
Expand All @@ -36,6 +37,14 @@ public static final int ArrowDown

Indicates ArrowDown shape.

### Circle {#Circle}
```
public static final int Circle
```


Indicates Circle shape.

### Diamond {#Diamond}
```
public static final int Diamond
Expand Down
15 changes: 15 additions & 0 deletions english/java/com.aspose.tasks/taskvalidationexception/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,18 @@ public class TaskValidationException extends RecalculationValidationException
```

Represents an exception which is thrown when errors are found in project's tasks after recalculation.
## Methods

| Method | Description |
| --- | --- |
| [getTask()](#getTask--) | Gets the task which caused the exception. |
### getTask() {#getTask--}
```
public final Task getTask()
```


Gets the task which caused the exception.

**Returns:**
[Task](../../com.aspose.tasks/task) - the task which caused the exception.