# DropHelper.Options

# DropHelper.Options

Artifact:[androidx.draganddrop:draganddrop](https://developer.android.com/jetpack/androidx/releases/draganddrop)  
[View Source](https://cs.android.com/search?q=file:androidx/draganddrop/DropHelper.java+class:androidx.draganddrop.DropHelper.Options)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/draganddrop#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/draganddrop/DropHelper.Options "View this page in Java")

<br />

```
class DropHelper.Options
```

<br />

*** ** * ** ***

Options for configuring drop targets specified by[DropHelper](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper).

## Summary

|                                                                                                                                   ### Nested types                                                                                                                                   |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[DropHelper.Options.Builder](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options.Builder) Builder for constructing a[DropHelper.Options](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options)instance. |

|                                                                                                                                    ### Public functions                                                                                                                                    |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `@`[ColorInt](https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt)` `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                                                                                   | [getHighlightColor](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#getHighlightColor())`()` Returns the color used to highlight the drop target.                                                                                                                                                                           |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                                                                                                                                                                                | [getHighlightCornerRadiusPx](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#getHighlightCornerRadiusPx())`()` Returns the corner radius of the drop target highlighting.                                                                                                                                                   |
| `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[EditText](https://developer.android.com/reference/android/widget/EditText.html)`!>` | [getInnerEditTexts](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#getInnerEditTexts())`()` Returns a list of the[EditText](https://developer.android.com/reference/android/widget/EditText.html)elements contained in the drop target view hierarchy.                                                                     |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                                                                                                                        | [hasHighlightColor](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#hasHighlightColor())`()` Indicates whether or not a drop target highlight color has been set.                                                                                                                                                           |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                                                                                                                        | [hasHighlightCornerRadiusPx](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#hasHighlightCornerRadiusPx())`()` Indicates whether or not a corner radius has been set for the drop target highlighting.                                                                                                                      |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                                                                                                                        | [shouldAcceptDragsWithLocalState](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#shouldAcceptDragsWithLocalState())`()` Indicates whether or not the app should respond to drag events when the drag operation contains[local state](https://developer.android.com/reference/android/view/DragEvent.html#getLocalState()). |

## Public functions

### getHighlightColor

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/draganddrop#1.0.0)  

```
fun getHighlightColor(): @ColorInt Int
```

Returns the color used to highlight the drop target.  

|                                                                                 Returns                                                                                  |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|
| `@`[ColorInt](https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt)` `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | The drop target highlight color. |

|                                                            See also                                                             |
|---------------------------------------------------------------------------------------------------------------------------------|---|
| [hasHighlightColor](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#hasHighlightColor()) |   |

### getHighlightCornerRadiusPx

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/draganddrop#1.0.0)  

```
fun getHighlightCornerRadiusPx(): Int
```

Returns the corner radius of the drop target highlighting.  

|                                   Returns                                   |
|-----------------------------------------------------------------------------|---------------------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | The drop target highlighting corner radius. |

|                                                                     See also                                                                      |
|---------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [hasHighlightCornerRadiusPx](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options#hasHighlightCornerRadiusPx()) |   |

### getInnerEditTexts

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/draganddrop#1.0.0)  

```
fun getInnerEditTexts(): (Mutable)List<EditText!>
```

Returns a list of the[EditText](https://developer.android.com/reference/android/widget/EditText.html)elements contained in the drop target view hierarchy. A list of`EditText`elements is supplied when building this[DropHelper.Options](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options)instance (see[addInnerEditTexts](https://developer.android.com/reference/kotlin/androidx/draganddrop/DropHelper.Options.Builder#addInnerEditTexts(android.widget.EditText...))).  

|                                                                                                                                          Returns                                                                                                                                           |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)`)`[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[EditText](https://developer.android.com/reference/android/widget/EditText.html)`!>` | The list of drop target`EditText`elements. |

### hasHighlightColor

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/draganddrop#1.0.0)  

```
fun hasHighlightColor(): Boolean
```

Indicates whether or not a drop target highlight color has been set. If not, a default is used.  

|                                       Returns                                       |
|-------------------------------------------------------------------------------------|----------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if a highlight color has been set, false otherwise. |

### hasHighlightCornerRadiusPx

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/draganddrop#1.0.0)  

```
fun hasHighlightCornerRadiusPx(): Boolean
```

Indicates whether or not a corner radius has been set for the drop target highlighting. If not, a default is used.  

|                                       Returns                                       |
|-------------------------------------------------------------------------------------|--------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if a corner radius has been set, false otherwise. |

### shouldAcceptDragsWithLocalState

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/draganddrop#1.0.0)  

```
fun shouldAcceptDragsWithLocalState(): Boolean
```

Indicates whether or not the app should respond to drag events when the drag operation contains[local state](https://developer.android.com/reference/android/view/DragEvent.html#getLocalState()). By default, the app does not respond to drag events that have local state. Setting local state is only possible when the drag operation originated from this activity.  

|                                       Returns                                       |
|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if drag events will be accepted when the local state is non-null, otherwise false. |