### AutoTest System State and Initialization

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/AutoTest

Methods for checking the overall system's readiness and installing locator shortcuts.

```APIDOC
## AutoTest System State and Initialization

### Description
Provides methods to check the overall system's completion status and to install utility shortcuts for retrieving element locators during development.

### Methods

#### `isSystemDone()`

##### Description
Returns a boolean to indicate whether the current application is fully loaded with no pending operations and is ready for user interaction.

##### Return Value
- `boolean` - `true` if the system is done, `false` otherwise.

#### `isSystemDone(boolean options)`

##### Description
Returns a boolean to indicate whether the current application is fully loaded with no pending operations and is ready for user interaction, considering specified options.

##### Parameters
- **options** (`boolean`) - Required - Configuration options for the system done check.

##### Return Value
- `boolean` - `true` if the system is done, `false` otherwise.

#### `isSystemDone(SystemDoneConfig options)`

##### Description
Returns a boolean to indicate whether the current application is fully loaded with no pending operations and is ready for user interaction, using a detailed configuration object.

##### Parameters
- **options** (`SystemDoneConfig`) - Required - Configuration object for the system done check.

##### Return Value
- `boolean` - `true` if the system is done, `false` otherwise.

#### `installLocatorShortcut()`

##### Description
Allows developers to retrieve locators for elements on the page via a key-combo plus mouse down on the element. This method can be invoked from a bookmarklet for a one-click locator retrieval.

##### Usage
This method is typically called once to enable the locator shortcut functionality.
```

--------------------------------

### Start Angle Management

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/drawing/DrawSector

Methods for getting and setting the start angle of the sector.

```APIDOC
## POST /setStartAngle

### Description
Sets the start angle of the sector in degrees. The sector sweeps clockwise towards the end angle. This method is deprecated.

### Method
POST

### Endpoint
/setStartAngle

### Parameters
#### Request Body
- **startAngle** (float) - New startAngle value. Default value is 0.0.

### Request Example
```json
{
  "startAngle": 90.0
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates successful update of the start angle.

#### Response Example
```json
{
  "message": "Start angle updated successfully."
}
```

## GET /getStartAngle

### Description
Retrieves the current start angle of the sector in degrees. This method is deprecated.

### Method
GET

### Endpoint
/getStartAngle

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **startAngle** (float) - Current start angle value. Default value is 0.0.

#### Response Example
```json
{
  "startAngle": 0.0
}
```
```

--------------------------------

### DateItem - Get Start Date

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/form/fields/DateItem

Retrieves the current start date value of the DateItem. This method returns the date that the component is currently configured to start with.

```APIDOC
## GET /dateItem/getStartDate

### Description
Retrieves the current startDate value. Default value is See below

### Method
GET

### Endpoint
/dateItem/getStartDate

### Response
#### Success Response (200)
- **startDate** (Date) - Current startDate value. Default value is See below

#### Response Example
{
  "startDate": "2023-10-27T10:00:00"
}
```

--------------------------------

### Project Start Screen Creation

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/Project

Methods for creating the initial screen of a project.

```APIDOC
## createStartScreen

### createStartScreen()

Creates screen from first definition cached in the project.

**Returns**
Canvas - last top-level widget in the screen definition

**See Also**
- `createScreen(java.lang.String)`
- `RPCManager.createScreen(java.lang.String)`

### createStartScreen(CreateScreenSettings settings)

Creates screen from first definition cached in the project.

**Parameters**
- `settings` (CreateScreenSettings) - widgets to allow to take their global IDs, or a widget remap config

**Returns**
Canvas - last top-level widget in the screen definition

**See Also**
- `createScreen(java.lang.String)`
- `RPCManager.createScreen(java.lang.String)`

### createStartScreen(String... settings)

Creates screen from first definition cached in the project.

**Parameters**
- `settings` (String...) - widgets to allow to take their global IDs, or a widget remap config

**Returns**
Canvas - last top-level widget in the screen definition

**See Also**
- `createScreen(java.lang.String)`
- `RPCManager.createScreen(java.lang.String)`
```

--------------------------------

### ImgButton Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/ImgButton

Details on how to create an ImgButton instance.

```APIDOC
## Constructor Details

### ImgButton()

Public constructor for ImgButton.

### ImgButton(JavaScriptObject jsObj)

Public constructor for ImgButton, initializing with a JavaScriptObject.
```

--------------------------------

### Get Layout Start Margin - Java

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/layout/Layout

Retrieves the start margin for the layout, which is equivalent to the left margin for horizontal layouts or the top margin for vertical layouts. Specific margins take precedence over the start margin.

```java
public Integer getLayoutStartMargin()
// Equivalent to `layoutLeftMargin` for a horizontal layout, or `layoutTopMargin` for a vertical layout.
// If both `layoutStartMargin` and the more specific properties (top/left margin) are both set, the more specific properties win.
// Returns:
//     Current layoutStartMargin value. Default value is null
```

--------------------------------

### Java Interface and Initialization Example

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/tile/TileGrid

Defines a CarTileMetaFactory interface and demonstrates module loading and TileGrid initialization in Java. It shows how to create a CarTileMetaFactory and configure a TileGrid with a custom tile constructor.

```java
public interface CarTileMetaFactory extends BeanFactory.MetaFactory {
  BeanFactory getCarTileFactory();
}
public void onModuleLoad() {
  GWT.create(CarTileMetaFactory.class);
  TileGrid tileGrid = new TileGrid();
  tileGrid.setTileConstructor(CarTile.class.getName());
  tileGrid.draw();
}
```

--------------------------------

### Get and Set Start Value for RangeSlider (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/RangeSlider

Methods to retrieve and set the starting value of the selected range in the RangeSlider. `getStartValue` returns the current start value, and `setStartValue` updates it. Float versions are deprecated in favor of double.

```java
public float getStartValue()
public RangeSlider setStartValue(double startValue)
```

--------------------------------

### Get Event Start Date

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/calendar/Calendar

Retrieves the start date of a given CalendarEvent. This method is essential for scheduling and timeline-based operations where knowing an event's precise start time is critical. It takes the event as input and returns a Date object.

```java
public Date getEventStartDate(CalendarEvent event)
Returns the `start date` of the passed event. 

Parameters:
    `event` - the event to get the start date of 

Returns:
    the start date of the passed event
```

--------------------------------

### Constructor Details

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/SeleneseRecorder

Details about the constructors available for SeleneseRecorder.

```APIDOC
## Constructor Details

### SeleneseRecorder

```java
public SeleneseRecorder()
```

Description:
Initializes a new instance of the SeleneseRecorder class.

### SeleneseRecorder

```java
public SeleneseRecorder(JavaScriptObject jsObj)
```

Parameters:
* **jsObj** (JavaScriptObject) - The JavaScript object to associate with the recorder.
```

--------------------------------

### Get New Screen Picker Title (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/tour/Tour

Retrieves the title for the 'Start with New Screen' picker in the Tour Wizard. The default title is 'Start With New Screen'.

```Java
public String getTourWizardNewScreenPickerTitle()
Title for the _Start with New Screen_ picker in the Tour Wizard. 

Returns:
    Current tourWizardNewScreenPickerTitle value. Default value is "Start With New Screen" 

See Also:
    
      * `HTMLString`
```

--------------------------------

### ToolStrip Instance Methods

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/toolbar/ToolStrip

Methods for interacting with and configuring a ToolStrip instance.

```APIDOC
## ToolStrip Instance Methods

### create()

Protected method to create the component.

Overrides:
- `create` in class `Layout`

Returns:
- JavaScriptObject
```

```APIDOC
### getFormWrapper()

Returns the DynamicForm instance created by `addFormItem()` to contain form items for display in this toolStrip. Each time addFormItem() is run, a new formWrapper autoChild will be created, picking up properties according to the standard `com.smartgwt.client.types.AutoChild` pattern.

Note: This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See `Using AutoChildren` for details.

Returns:
- DynamicForm - null
```

```APIDOC
### setResizeBarClass(String resizeBarClass)

Sets a customized resizeBar with typical appearance for a ToolStrip.

Overrides:
- `setResizeBarClass` in class `Layout`

Parameters:
- **resizeBarClass** (String) - New resizeBarClass value. Default value is "ToolStripResizer"

Returns:
- ToolStrip - ToolStrip instance, for chaining setter calls

Throws:
- IllegalStateException - This property cannot be changed after the component has been created.

See Also:
- `Splitbar`
- `ImgSplitbar`
```

```APIDOC
### getResizeBarClass()

Gets the customized resizeBar with typical appearance for a ToolStrip.

Overrides:
- `getResizeBarClass` in class `Layout`

Returns:
- String - Current resizeBarClass value. Default value is "ToolStripResizer"

See Also:
- `Splitbar`
- `ImgSplitbar`
```

```APIDOC
### setResizeBarSize(int resizeBarSize)

Sets the thickness of the resizeBars in pixels.

Overrides:
- `setResizeBarSize` in class `Layout`

Parameters:
- **resizeBarSize** (int) - New resizeBarSize value. Default value is 14

Returns:
- ToolStrip - ToolStrip instance, for chaining setter calls

Throws:
- IllegalStateException - This property cannot be changed after the component has been created.

Note: This is an advanced setting.
```

```APIDOC
### getResizeBarSize()

Gets the thickness of the resizeBars in pixels.

Overrides:
- `getResizeBarSize` in class `Layout`

Returns:
- int - Current resizeBarSize value. Default value is 14
```

```APIDOC
### setSeparatorBreadth(int separatorBreadth)

Sets the separator height, when vertical is true, or width otherwise.

Parameters:
- **separatorBreadth** (int) - New separatorBreadth value. Default value is 22

Returns:
- ToolStrip - ToolStrip instance, for chaining setter calls

Throws:
- IllegalStateException - This property cannot be changed after the component has been created.
```

```APIDOC
### getSeparatorBreadth()

Gets the separator height, when vertical is true, or width otherwise.

Returns:
- int - Current separatorBreadth value. Default value is 22
```

```APIDOC
### setSeparatorClass(String separatorClass)

Sets the class to create when the string "separator" appears in `members`.

Parameters:
- **separatorClass** (String) - New separatorClass value. Default value is "ToolStripSeparator"

Returns:
- ToolStrip - ToolStrip instance, for chaining setter calls

Throws:
- IllegalStateException - This property cannot be changed after the component has been created.
```

```APIDOC
### getSeparatorClass()

Gets the class to create when the string "separator" appears in `members`.

Returns:
- String - Current separatorClass value. Default value is "ToolStripSeparator"
```

```APIDOC
### setSeparatorSize(int separatorSize)

Sets the separator size.

Parameters:
- **separatorSize** (int) - New separatorSize value.

Returns:
- ToolStrip - ToolStrip instance, for chaining setter calls

Throws:
- IllegalStateException - This property cannot be changed after the component has been created.
```

--------------------------------

### LoadScreenSettings Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/LoadScreenSettings

Provides information on how to create instances of the LoadScreenSettings class.

```APIDOC
## Constructor Details

### LoadScreenSettings

```java
public LoadScreenSettings()
```

Description:
Initializes a new instance of the LoadScreenSettings class with default values.

### LoadScreenSettings

```java
public LoadScreenSettings(JavaScriptObject jsObj)
```

Description:
Initializes a new instance of the LoadScreenSettings class using a JavaScriptObject.

Parameters:
* **jsObj** (JavaScriptObject) - The JavaScriptObject to initialize the settings with.
```

--------------------------------

### GET /records

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/RecordList

Retrieves a list of records from the SmartClient system within a specified range. The range is defined by 'start' and 'end' positions, returning items from 'start' up to, but not including, 'end'.

```APIDOC
## GET /records

### Description
Retrieves a list of records from the SmartClient system within a specified range. The range is defined by 'start' and 'end' positions, returning items from 'start' up to, but not including, 'end'.

### Method
GET

### Endpoint
/records

### Parameters
#### Query Parameters
- **start** (integer) - Required - The starting position (inclusive) for retrieving records.
- **end** (integer) - Required - The ending position (exclusive) for retrieving records.

### Request Example
```
GET /records?start=0&end=50
```

### Response
#### Success Response (200)
- **RecordList** (Array) - A list of records within the specified range.

#### Response Example
```json
{
  "RecordList": [
    {
      "field1": "value1",
      "field2": "value2"
    },
    {
      "field1": "value3",
      "field2": "value4"
    }
  ]
}
```
```

--------------------------------

### Get Start Angle as Double from DrawSector (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/drawing/DrawSector

Retrieves the start angle of the sector in degrees as a double. The default value is 0.0. This method is useful for understanding the current orientation of the sector.

```java
public double getStartAngleAsDouble()
```

--------------------------------

### AIWindow Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/ai/AIWindow

Provides information on how to instantiate the AIWindow class.

```APIDOC
## Constructors

### AIWindow()

Public constructor for AIWindow.

### AIWindow(JavaScriptObject jsObj)

Public constructor for AIWindow, accepting a JavaScriptObject.

```

--------------------------------

### Toolbar Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/toolbar/Toolbar

Provides information on how to create new instances of the Toolbar.

```APIDOC
## Constructor Summary

### `Toolbar()`

Creates a new Toolbar instance.

### `Toolbar(JavaScriptObject jsObj)`

Creates a new Toolbar instance with a given JavaScriptObject. This is typically used for internal framework purposes.
```

--------------------------------

### Add Drag Start Handler in Java

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/Canvas

Adds a handler executed when dragging first starts. It can be used for setup and returning false cancels the drag action. A drag starts after Canvas.dragStartDistance movement with the left mouse button pressed. The handler is specified in the HasDragStartHandlers interface.

```Java
public HandlerRegistration addDragStartHandler(DragStartHandler handler)
```

--------------------------------

### Get Process Start Element (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/workflow/Process

Retrieves the ID of the element or sequence designated as the starting point for the process. This is useful for debugging or dynamically determining the process's entry point.

```Java
String startElement = process.getStartElement();
```

--------------------------------

### ToolStrip Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/toolbar/ToolStrip

Provides details on how to instantiate a ToolStrip component.

```APIDOC
## ToolStrip Constructors

### ToolStrip()

Creates a new ToolStrip instance.

### ToolStrip(JavaScriptObject jsObj)

Creates a ToolStrip instance from a JavaScriptObject.

Parameters:
- **jsObj** (JavaScriptObject) - The JavaScript object to instantiate the ToolStrip from.
```

--------------------------------

### Get Fiscal Period Start Date (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/DateUtil

Retrieves the starting date for a specified fiscal year within a given `FiscalCalendar`. This method is useful for applications that operate on custom fiscal periods rather than standard calendar years.

```java
public static Date getFiscalStartDate(Integer year, FiscalCalendar fiscalCalendar)
```

--------------------------------

### WebService Initialization

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/WebService

Details on how to create and initialize WebService objects.

```APIDOC
## Constructors

### `WebService()`
Default constructor.

### `WebService(JavaScriptObject jsObj)`
Constructor that takes a JavaScriptObject.
```

--------------------------------

### Create Screen with Settings

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/CreateScreenSettings

Demonstrates how to create a screen using RPCManager.createScreen with custom CreateScreenSettings. This is useful for advanced configuration before drawing the screen.

```java
CreateScreenSettings settings = new CreateScreenSettings();
settings.setSuppressAutoDraw(true);
Canvas screen = RPCManager.createScreen("My Screen", settings);
screen.setHtmlElement(element);
screen.setHtmlPosition(DrawPosition.REPLACE);
screen.setPosition(Positioning.RELATIVE);
screen.draw();
```

--------------------------------

### Get Event Stream Start Time

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/stream/EventStream

This Java method returns the Date object representing when the event stream began capturing events, which corresponds to when the `start()` method was invoked. This is useful for time-based analysis or debugging of captured events.

```java
public Date getStartTime()
```

--------------------------------

### AdaptiveMenu Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/menu/AdaptiveMenu

Details on how to create an instance of AdaptiveMenu.

```APIDOC
## Constructors

### AdaptiveMenu()

Public constructor for AdaptiveMenu.

### AdaptiveMenu(JavaScriptObject jsObj)

Constructor for AdaptiveMenu that takes a JavaScriptObject.

### AdaptiveMenu(MenuItem[] items)

Constructor for AdaptiveMenu that takes an array of MenuItems.

### AdaptiveMenu(Menu menu)

Constructor for AdaptiveMenu that takes a Menu object.
```

--------------------------------

### Get All Nodes (Root)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/tree/Tree

Retrieves all nodes in the tree starting from the root, returned as a flat list in depth-first traversal order.

```APIDOC
## GET /websites/smartclient_smartgwtee-15_0_javadoc/getAllNodes

### Description
Gets all the nodes that exist in the tree under the root node, as a flat list, in depth-first traversal order.

### Method
GET

### Endpoint
/websites/smartclient_smartgwtee-15_0_javadoc/getAllNodes

### Parameters
There are no parameters for this endpoint.

### Response
#### Success Response (200)
- **TreeNode[]** - All the nodes that exist in the tree.
```

--------------------------------

### Slider Track Cap Size API

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/Slider

Allows setting and getting the size of the start and end images for slider tracks.

```APIDOC
## GET /slider/trackCapSize

### Description
Retrieves the current height of vertical slider start and end images, or width of horizontal slider start and end images.

### Method
GET

### Endpoint
/slider/trackCapSize

### Parameters
#### Query Parameters
None

### Request Example
```
GET /slider/trackCapSize
```

### Response
#### Success Response (200)
- **trackCapSize** (integer) - The current track cap size.

#### Response Example
```json
{
  "trackCapSize": 6
}
```

## POST /slider/trackCapSize

### Description
Sets the height of vertical slider start and end images, or width of horizontal slider start and end images. If called after the component has been drawn/initialized, it sets the `trackCapSize` property of the slider.

### Method
POST

### Endpoint
/slider/trackCapSize

### Parameters
#### Query Parameters
- **trackCapSize** (integer) - Required - The new track cap size. Default value is 6.

### Request Example
```
POST /slider/trackCapSize?trackCapSize=10
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the track cap size has been updated.

#### Response Example
```json
{
  "message": "Track cap size updated successfully."
}
```
```

--------------------------------

### Project Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/rpc/Project

Provides details on how to instantiate a Project object.

```APIDOC
## Constructors

### Project()

Default constructor for the Project class.

### Project(JavaScriptObject jsObj)

Constructor that initializes a Project object using a JavaScriptObject.
```

--------------------------------

### AIEngine Static and Initialization Methods (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/ai/AIEngine

Provides methods for creating and managing AIEngine instances, including static retrieval and setting JavaScript objects.

```java
public static AIEngine getOrCreateRef(JavaScriptObject jsObj)
public void setJavaScriptObject(JavaScriptObject jsObj)
```

--------------------------------

### Get Records within a Range

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/data/RecordList

Returns a subset of Records from the list between a specified start position (inclusive) and end position (exclusive).

```java
public Record[] getRange(int start, int end)
```

--------------------------------

### PaletteNode Instance Methods

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/PaletteNode

Documentation for instance methods of the PaletteNode class, covering retrieval and setting of component properties, defaults, and live objects.

```APIDOC
## Instance Methods

### getAlwaysUsePlaceholder() (Boolean)

**Description:** If set to true, indicates that a Placeholder should always be shown in place of the actual component.

### setAlwaysUsePlaceholder(Boolean alwaysUsePlaceholder) (PaletteNode)

**Description:** If set to true, indicates that a Placeholder should always be shown in place of the actual component.

### getCanDuplicate() (Boolean)

**Description:** If set to false, indicates that this node cannot be `copy & pasted`, including disallowing calls to `EditContext.makePaletteNode()` for `EditNodes` created from this `PaletteNode`.

### setCanDuplicate(Boolean canDuplicate) (PaletteNode)

**Description:** If set to false, indicates that this node cannot be `copy & pasted`, including disallowing calls to `EditContext.makePaletteNode()` for `EditNodes` created from this `PaletteNode`.

### getCanvasDefaults() (Canvas)

**Description:** Defaults for the component to be created from this palette.

### setCanvasDefaults(Canvas defaults) (PaletteNode)

**Description:** Defaults for the component to be created from this palette.

### getCanvasLiveObject() (Canvas)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### setCanvasLiveObject(Canvas liveObject) (PaletteNode)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### getDrawItemDefaults() (DrawItem)

**Description:** Defaults for the component to be created from this palette.

### setDrawItemDefaults(DrawItem defaults) (PaletteNode)

**Description:** Defaults for the component to be created from this palette.

### getDrawItemLiveObject() (DrawItem)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### setDrawItemLiveObject(DrawItem liveObject) (PaletteNode)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### getDrawPaneDefaults() (DrawPane)

**Description:** Defaults for the component to be created from this palette.

### setDrawPaneDefaults(DrawPane defaults) (PaletteNode)

**Description:** Defaults for the component to be created from this palette.

### getDrawPaneLiveObject() (DrawPane)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### setDrawPaneLiveObject(DrawPane liveObject) (PaletteNode)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### getEditNodeProperties() (EditNode)

**Description:** Properties to be applied to the `editNode` when created.

### setEditNodeProperties(EditNode editNodeProperties) (PaletteNode)

**Description:** Properties to be applied to the `editNode` when created.

### getEditProxyProperties() (Object)

**Description:** Properties to be applied to the `liveObject`.`editProxy` when created.

### getFormItemDefaults() (FormItem)

**Description:** Defaults for the component to be created from this palette.

### setFormItemDefaults(FormItem defaults) (PaletteNode)

**Description:** Defaults for the component to be created from this palette.

### getFormItemLiveObject() (FormItem)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### setFormItemLiveObject(FormItem liveObject) (PaletteNode)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### getIcon() (String)

**Description:** Icon for this paletteNode.

### getIdName() (String)

**Description:** Name used to create unique component ID.

### getIdPrefix() (String)

**Description:** Deprecated. As of Smart GWT version 12.1, deprecated in favor of `idName`.

### getLiveObject() (Object)

**Description:** For a paletteNode which should be a "singleton", that is, always provides the exact same object (==) rather than a dynamically created copy, provide the singleton object as `liveObject`.

### getPlaceholderImage() (String)

**Description:** Image to display in lieu of the usual placeholder text.

### getPlaceholderProperties() (Label)

**Description:** Properties to be applied to the `liveObject` when created as a Placeholder.

### getRecreateOnChange() (Boolean)

**Description:** If set to true, indicates instead of updating the changed property on the target live component a new live component is created with the current configured properties.

### getRequiredProperties() (String)

**Description:** Comma separated list of properties for this component that must be provided in `EditNode.defaults` before the component will be created.

### getTitle() (String)

**Description:** Textual title for this paletteNode.

### getType() (String)

**Description:** String this paletteNode creates, for example, "ListGrid".
```

--------------------------------

### Shorter includeFrom with Full includeVia (XML)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/IncludeViaSyntax

Example where includeFrom starts mid-chain, but includeVia ensures the correct relation chain is established from the base DataSource. This provides flexibility in defining the start of the relation path.

```XML
includeFrom="Employee.Office.city"
includeVia="Order.customerNumber:Customer.accountMgrEmployeeNumber:Employee.officeCode"
```

--------------------------------

### VLayout Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/layout/VLayout

Details the different ways to instantiate the VLayout class.

```APIDOC
## Constructor Details

### VLayout

```java
public VLayout()
```

Initializes a new VLayout instance with default settings.

### VLayout

```java
public VLayout(JavaScriptObject jsObj)
```

Initializes a new VLayout instance using a provided JavaScriptObject.

### VLayout

```java
public VLayout(int membersMargin)
```

Initializes a new VLayout instance with a specified margin for its members.
```

--------------------------------

### Get All Nodes (Specific Node)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/tree/Tree

Retrieves all nodes in the tree starting from a specified node, returned as a flat list in depth-first traversal order.

```APIDOC
## GET /websites/smartclient_smartgwtee-15_0_javadoc/getAllNodes

### Description
Gets all the nodes that exist in the tree under a particular node, as a flat list, in depth-first traversal order.

### Method
GET

### Endpoint
/websites/smartclient_smartgwtee-15_0_javadoc/getAllNodes

### Parameters
#### Query Parameters
- **node** (TreeNode) - Optional - The node to start from. Defaults to the root if not provided.

### Response
#### Success Response (200)
- **TreeNode[]** - All the nodes that exist in the tree under the specified node.
```

--------------------------------

### Configure Sample Photo Directory in Java

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/util/Page

Specifies the directory for skin-specific sample photos used in the product showcase. This method can be called without arguments or with a URL string. The URL parameter sets the new path for these photos.

```java
public static void setSamplePhotoDir()
public static void setSamplePhotoDir(String URL)
```

--------------------------------

### Get Event Start Date Field Title (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/calendar/Calendar

Retrieves the current title for the 'startDateField' used in the event dialogs. The default value is 'From'.

```Java
public String getEventStartDateFieldTitle()
```

--------------------------------

### Axis Start and End Value Configuration

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/chart/FacetChart

Methods for setting and getting the start and end values for the primary axis of a FacetChart. These properties are crucial for defining the visible range of data and how values outside this range are handled. Special considerations apply to multi-axis, bubble, and scatter charts.

```APIDOC
## GET /api/facetChart/axisEndValue

### Description
Retrieves the current end value for the primary axis of the chart. If not explicitly set, it defaults to null, allowing the chart to determine an appropriate end value based on the data or other configuration.

### Method
GET

### Endpoint
/api/facetChart/axisEndValue

### Parameters
None

### Response
#### Success Response (200)
- **axisEndValue** (Double) - The current end value of the primary axis. Defaults to null.

#### Response Example
```json
{
  "axisEndValue": 100.0
}
```

## POST /api/facetChart/axisEndValue

### Description
Sets the end value for the primary axis of the chart. For multi-axis, bubble, and scatter charts, this affects only the first axis. Data points exceeding this value are omitted. For line charts, consider setting `discontinuousLines` to true.

### Method
POST

### Endpoint
/api/facetChart/axisEndValue

### Parameters
#### Request Body
- **axisEndValue** (Double) - The new end value for the primary axis. Default value is null.

### Request Example
```json
{
  "axisEndValue": 150.0
}
```

### Response
#### Success Response (200)
- **FacetChart** (FacetChart) - Returns the FacetChart instance for chaining.

#### Response Example
```json
{
  "message": "Axis end value updated successfully."
}
```

### Throws
- **IllegalStateException** - If the property is changed after the component has been created.

## POST /api/facetChart/axisStartValue

### Description
Sets the start value for the primary axis of the chart. If set explicitly, it is respected; otherwise, it defaults to 0 or a value optimizing vertical space based on `minDataSpreadPercent`. For multi-axis, bubble, and scatter charts, this affects only the first axis. Data points below this value are omitted.

### Method
POST

### Endpoint
/api/facetChart/axisStartValue

### Parameters
#### Request Body
- **axisStartValue** (Double) - The new start value for the primary axis. Default value is null.

### Request Example
```json
{
  "axisStartValue": 0.0
}
```

### Response
#### Success Response (200)
- **FacetChart** (FacetChart) - Returns the FacetChart instance for chaining.

#### Response Example
```json
{
  "message": "Axis start value updated successfully."
}
```

### Throws
- **IllegalStateException** - If the property is changed after the component has been created.

## GET /api/facetChart/axisStartValue

### Description
Retrieves the current start value for the primary axis of the chart. If not explicitly set, it defaults to 0 or a value that optimizes vertical space based on `minDataSpreadPercent`.

### Method
GET

### Endpoint
/api/facetChart/axisStartValue

### Parameters
None

### Response
#### Success Response (200)
- **axisStartValue** (Double) - The current start value of the primary axis. Defaults to null.

#### Response Example
```json
{
  "axisStartValue": 0.0
}
```
```

--------------------------------

### ImgButton Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/ImgButton

Details the constructors available for creating ImgButton instances.

```APIDOC
## Constructors

### `ImgButton()`

Default constructor for ImgButton.

### `ImgButton(JavaScriptObject jsObj)`

Constructor that accepts a JavaScriptObject.
```

--------------------------------

### Get Axis Start Value for FacetChart (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/chart/FacetChart

Retrieves the current starting value for the primary axis of a FacetChart. This value can default to 0 or be adjusted for optimal vertical space. It affects only the first axis in multi-axis, Bubble, and Scatter charts. Returns null if not explicitly set.

```java
public Double getAxisStartValue()
```

--------------------------------

### AIEngine Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/ai/AIEngine

Provides details on how to instantiate the AIEngine class.

```APIDOC
## Constructors

### AIEngine()

A default constructor for the AIEngine class.

### AIEngine(JavaScriptObject jsObj)

Constructs an AIEngine instance using a provided JavaScriptObject.

Parameters:
- `jsObj` (JavaScriptObject) - The JavaScriptObject to initialize the AIEngine with.
```

--------------------------------

### Example ProjectFile DataSource Configuration

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/docs/serverds/DataSource

This example demonstrates a complete `projectFile` DataSource configuration in XML. It includes setting the `type` to `projectFile`, `inheritsFrom` to `ProjectFile` for predefined field definitions, and defining the `projectFileLocations` to specify where the project files should be sourced from. This setup is useful for managing data sources that read directly from project files.

```xml
<DataSource ID="MyDataSources" type="projectFile" inheritsFrom="ProjectFile">
    <projectFileLocations>
        <location>[WEBROOT]/shared/ds</location>
        <location>ds://datasources</location>
    </projectFileLocations>
</DataSource>
```

--------------------------------

### Layout Configuration Methods

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/layout/Layout

Methods for configuring padding, placeholder, resize bar, order, visibility, and stacking behavior within a Layout.

```APIDOC
## Layout Class Methods

### setPaddingAsLayoutMargin

#### Description
If this widget has padding specified (as `this.padding` or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?

#### Method
`setPaddingAsLayoutMargin(Boolean paddingAsLayoutMargin)`

#### Endpoint
N/A (Method within a class)

### setPlaceHolderDefaults

#### Description
If `this.showDragPlaceHolder` is true, this defaults object determines the default appearance of the placeholder displayed when the user drags a widget out of this layout. Default value for this property sets the placeholder `styleName` to `"layoutPlaceHolder"`. To modify this object, use `Class.changeDefaults()`.

#### Method
`setPlaceHolderDefaults(Canvas placeHolderDefaults)`

#### Endpoint
N/A (Method within a class)

### setPlaceHolderProperties

#### Description
If `this.showDragPlaceHolder` is true, this properties object can be used to customize the appearance of the placeholder displayed when the user drags a widget out of this layout.

#### Method
`setPlaceHolderProperties(Canvas placeHolderProperties)`

#### Endpoint
N/A (Method within a class)

### setResizeBarClass

#### Description
Default class to use for creating `resizeBars`.

#### Method
`setResizeBarClass(String resizeBarClass)`

#### Endpoint
N/A (Method within a class)

### setResizeBarSize

#### Description
Thickness of the resizeBar in pixels.

#### Method
`setResizeBarSize(int resizeBarSize)`

#### Endpoint
N/A (Method within a class)

### setReverseOrder

#### Description
Reverse the order of stacking for this Layout, so that the last member is shown first.

#### Method
`setReverseOrder(Boolean reverseOrder)`

#### Endpoint
N/A (Method within a class)

### setShowDragPlaceHolder

#### Description
If set to true, when a member is dragged out of layout, a visible placeholder canvas will be displayed in place of the dragged widget for the duration of the drag and drop interaction.

#### Method
`setShowDragPlaceHolder(Boolean showDragPlaceHolder)`

#### Endpoint
N/A (Method within a class)

### setShowDropLines

#### Description
Controls whether to show a drop-indicator during a drag and drop operation.

#### Method
`setShowDropLines(Boolean showDropLines)`

#### Endpoint
N/A (Method within a class)

### setStackZIndex

#### Description
For use in conjunction with `memberOverlap`, controls the z-stacking order of members.

#### Method
`setStackZIndex(String stackZIndex)`

#### Endpoint
N/A (Method within a class)

### setVertical

#### Description
Should this layout appear with members stacked vertically or horizontally.

#### Method
`setVertical(Boolean vertical)`

#### Endpoint
N/A (Method within a class)

### setVPolicy

#### Description
Sizing policy applied to members on vertical axis.

#### Method
`setVPolicy(LayoutPolicy vPolicy)`

#### Endpoint
N/A (Method within a class)
```

--------------------------------

### SectionStack - Item Indentation Methods

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/layout/SectionStack

Methods for controlling the indentation of items within a SectionStack, including setting and getting item indent, start indent, and end indent.

```APIDOC
## GET /sectionstack/itemindent

### Description
Retrieves the size, in pixels, of indentation for all member items within a SectionStack. Items will be offset and reduced in width by this amount. This value is overridden by `itemStartIndent` or `itemEndIndent`.

### Method
GET

### Endpoint
/sectionstack/itemindent

### Parameters
None

### Response
#### Success Response (200)
- **itemIndent** (int) - The current itemIndent value. Default value is 0.

#### Response Example
```json
{
  "itemIndent": 10
}
```

## GET /sectionstack/itemstartindent

### Description
Retrieves the size, in pixels, of indentation for all member items relative to the start of the alignment axis within a SectionStack. For instance, for left-aligned members, itemStartIndent specifies indentation for every item from the left side of the section stack. This setting overrides `itemIndent`.

### Method
GET

### Endpoint
/sectionstack/itemstartindent

### Parameters
None

### Response
#### Success Response (200)
- **itemStartIndent** (int) - The current itemStartIndent value. Default value is undefined.

#### Response Example
```json
{
  "itemStartIndent": 5
}
```

## GET /sectionstack/itemendindent

### Description
Retrieves the size, in pixels, of indentation for all member items relative to the end of the alignment axis within a SectionStack. For instance, for left-aligned members, itemEndIndent specifies indentation for every item from the right side of the section stack.

### Method
GET

### Endpoint
/sectionstack/itemendindent

### Parameters
None

### Response
#### Success Response (200)
- **itemEndIndent** (int) - The current itemEndIndent value. Default value is undefined.

#### Response Example
```json
{
  "itemEndIndent": 15
}
```

## POST /sectionstack/setitemindent

### Description
Sets the size, in pixels, of indentation for all member items within a SectionStack. Items will be offset and reduced in width by this amount. This value is overridden by `itemStartIndent` or `itemEndIndent`. Setting itemIndent is equivalent to setting itemStartIndent to the same amount and itemEndIndent to 0.

### Method
POST

### Endpoint
/sectionstack/setitemindent

### Parameters
#### Request Body
- **itemIndent** (int) - New itemIndent value. Default value is 0.

### Request Example
```json
{
  "itemIndent": 10
}
```

### Response
#### Success Response (200)
- **SectionStack** (object) - Returns the SectionStack instance for chaining setter calls.

#### Response Example
```json
{
  "message": "itemIndent set successfully"
}
```

## POST /sectionstack/setitemstartindent

### Description
Sets the size, in pixels, of indentation for all member items relative to the start of the alignment axis within a SectionStack. For instance, for left-aligned members, itemStartIndent specifies indentation for every item from the left side of the section stack. This setting overrides `itemIndent`.

### Method
POST

### Endpoint
/sectionstack/setitemstartindent

### Parameters
#### Request Body
- **itemStartIndent** (int) - New itemStartIndent value. Default value is undefined.

### Request Example
```json
{
  "itemStartIndent": 5
}
```

### Response
#### Success Response (200)
- **SectionStack** (object) - Returns the SectionStack instance for chaining setter calls.

#### Response Example
```json
{
  "message": "itemStartIndent set successfully"
}
```

## POST /sectionstack/setitemendindent

### Description
Sets the size, in pixels, of indentation for all member items relative to the end of the alignment axis within a SectionStack. For instance, for left-aligned members, itemEndIndent specifies indentation for every item from the right side of the section stack.

### Method
POST

### Endpoint
/sectionstack/setitemendindent

### Parameters
#### Request Body
- **itemEndIndent** (int) - New itemEndIndent value. Default value is undefined.

### Request Example
```json
{
  "itemEndIndent": 15
}
```

### Response
#### Success Response (200)
- **SectionStack** (object) - Returns the SectionStack instance for chaining setter calls.

#### Response Example
```json
{
  "message": "itemEndIndent set successfully"
}
```
```

--------------------------------

### SummarizeValueExample Constructors

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/ai/SummarizeValueExample

Provides details on how to instantiate the SummarizeValueExample class.

```APIDOC
## Constructor Summary

Constructors

### SummarizeValueExample

```java
public SummarizeValueExample()
```

### SummarizeValueExample

```java
public SummarizeValueExample(JavaScriptObject jsObj)
```
```

--------------------------------

### Get Type for PaletteNode (Java)

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/tools/PaletteNode

Retrieves the string representing the type of object this palette node creates, for example, "ListGrid". The default value is null.

```java
public String getType()

```

--------------------------------

### ImgButton Methods

Source: https://smartclient.com/smartgwtee-15.0/javadoc/com/smartgwt/client/widgets/ImgButton

Provides information on the methods available for interacting with and configuring ImgButton components.

```APIDOC
## Methods

### `void action()`

This property contains the default 'action' for the Button to fire when activated.

### `HandlerRegistration addTitleHoverHandler(TitleHoverHandler handler)`

Add a titleHover handler.

### `void addToRadioGroup(String groupID)`

Add this widget to the specified mutually exclusive selection group with the ID passed in.

### `static void changeAutoChildDefaults(String autoChildName, Canvas defaults)`

Changes the defaults for Canvas AutoChildren named `autoChildName`.

### `static void changeAutoChildDefaults(String autoChildName, FormItem defaults)`

Changes the defaults for FormItem AutoChildren named `autoChildName`.

### `protected JavaScriptObject create()`

Creates the underlying JavaScript object for the ImgButton.

### `void deselect()`

Select this object.

### `SelectionType getActionType()`

Behavior on state changes -- BUTTON, RADIO or CHECKBOX.

### `Alignment getAlign()`

Horizontal alignment of this component's title.

### `Boolean getAutoFit()`

If true, ignore the specified size of this widget and always size just large enough to accommodate the title.

### `String getBaseStyle()`

Base CSS style className applied to the component.

### `Integer getHeight()`

Size for this component's vertical dimension.

### `String getHeightAsString()`

Size for this component's vertical dimension.

### `Boolean getHiliteAccessKey()`

If set to true, if the `title` of this button contains the specified `accessKey`, when the title is displayed to the user it will be modified to include HTML to underline the accessKey. Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.

### `String getIcon()`

Optional icon to be shown with the button title text.

### `String getIconAlign()`

If this button is showing an icon should it be right or left aligned?

### `Integer getIconHeight()`

Height in pixels of the icon image.

### `String getIconOrientation()`

If this button is showing an icon should it appear to the left or right of the title? valid options are `"left"` and `"right"`.

### `int getIconSize()`

Size in pixels of the icon image.

### `int getIconSpacing()`

Pixels between icon and title text.

### `Integer getIconWidth()`

Width in pixels of the icon image.

### `Integer getLabelHPad()`

Horizontal padding to be applied to this widget's label.

### `Integer getLabelVPad()`

Vertical padding to be applied to this widget's label.

### `LogicalStructureObject getLogicalStructure()`

Getter implementing the `LogicalStructure` interface, which supports Eclipse's logical structure debugging facility.

### `static ImgButton getOrCreateRef(JavaScriptObject jsObj)`

Gets or creates a reference to an ImgButton instance from a JavaScriptObject.

### `String getRadioGroup()`

String identifier for this canvas's mutually exclusive selection group.

### `Boolean getShowClippedTitleOnHover()`

If true and the title is clipped, then a hover containing the full title of this button is enabled.

### `Boolean getShowDisabled()`

Should we visibly change state when disabled?

### `Boolean getShowDisabledIcon()`

If using an icon for this button, whether to switch the icon image if the button becomes disabled.

### `Boolean getShowDown()`

Should we visibly change state when the mouse goes down in this object?

### `Boolean getShowDownIcon()`

If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.

### `Boolean getShowFocused()`

Should we visibly change state when the canvas receives focus? If `StatefulCanvas.showFocusedAsOver` is `true`, then `"over"` will be used to indicate focus.

### `Boolean getShowFocusedIcon()`

If using an icon for this button, whether to switch the icon image when the button receives focus.

### `Boolean getShowRollOver()`

Should we visibly change state when the mouse goes over this object?

### `Boolean getShowRollOverIcon()`

If using an icon for this button, whether to switch the icon image on mouse rollover.

### `Boolean getShowSelectedIcon()`

If using an icon for this button, whether to switch the icon image when the button becomes selected.

### `Boolean getShowTitle()`

Determines whether any specified `title` will be displayed for this component. Applies to Image-based components only, where the title will be rendered out in a label floating over the component.

### `String getSrc()`

The base filename or stateful image configuration for the image.

### `SCStatefulImgConfig getSrcAsSCStatefulImgConfig()`

The base filename or stateful image configuration for the image.

### `State getState()`

Current "state" of this widget.

### `String getTitle()`

The title HTML to display in this button.

### `VerticalAlignment getValign()`

Vertical alignment of this component's title.

### `Integer getWidth()`

Size for this component's horizontal dimension.
```