# cp.ui.Cell
Represents an `AXCell` `axuielement`. This can be used directly, or can be subclassed to provide more specific access to the cell contents.
It is typically used in conjunction with a container type such as [Table](cp.ui.Table.md), something like this:
```lua
function MyPanel.lazy.value:tableOfStuff()
return Table:withRowsOf(
Row:containing(
Cell:with(TextField), Cell:with(Button)
)
)(self, self.UI:mutate(chain // uielement >> attribute "AXContents"))
end
```
This is a subclass of [Element](cp.ui.Element.md).
---
## API Overview
**Functions** - _API calls offered directly by the extension_
* [matches](#matches)
* [with](#with)
**Constructors** - _API calls which return an object, typically one that offers API methods_
* [Cell](#cell)
**Fields** - _Variables which can only be accessed from an object returned by a constructor_
* [children](#children)
* [childrenUI](#childrenui)
* [columnIndexRange](#columnindexrange)
* [rowIndexRange](#rowindexrange)
* [selected](#selected)
* [value](#value)
**Methods** - _API calls which can only be made on an object returned by a constructor_
* [textValueIs](#textvalueis)
---
## API Documentation
#### Functions
### [matches](#matches)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.matches(element) -> boolean` |
| **Type** | Function |
| **Description** | Checks if the `element` is an `AXCell`. |
| **Parameters** | - element - An element to check
|
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 30](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L30) |
---
### [with](#with)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell:with(...) -> function(parent, uiFinder) -> cp.ui.Cell.Builder` |
| **Type** | Function |
| **Description** | A combinator function that returns a `Cell.Builder` that accepts the `parent` and `uiFinder` to construct a new `Cell`. |
| **Parameters** | - ... - One or more arguments to pass to the constructor.
|
| **Returns** | - A [Cell.Builder](cp.ui.Cell.Builder.md)
|
| **Notes** | - For example, if a cell contains a [Button](cp.ui.Button.md), you can use `cp.ui.Cell:with(Button)`, and it will return a `Cell`
- `Builder` that accepts the `parent` and `uiFinder` parameters, and whose contents is expected to be a `Button`.
- That `Button` instance can be accessed via the `children[1]` value.
- ```
|
| **Examples** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 41](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L41) |
---
#### Constructors
### [Cell](#cell)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell(parent, uiFinder[, childInits]) -> Cell` |
| **Type** | Constructor |
| **Description** | Creates a new `Cell` instance. |
| **Parameters** | - parent - The parent `Element`.
- uiFinder - A `cp.prop` or `axuielement` that will be used to find this `Cell`'s `axuielement`.
- ... - The list of child `Element` builders to initialize.
|
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 57](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L57) |
---
#### Fields
### [children](#children)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.children ` |
| **Type** | Field |
| **Description** | The list of `Element`s which are children of this `Cell`, if the `childInits` were provided to the constructor. |
| **Notes** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 101](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L101) |
---
### [childrenUI](#childrenui)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.childrenUI ` |
| **Type** | Field |
| **Description** | The list of `axuielement`s which are children of this `Cell`. |
| **Notes** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 94](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L94) |
---
### [columnIndexRange](#columnindexrange)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.columnIndexRange ` |
| **Type** | Field |
| **Description** | Returns a table of `{len,loc}`, which indicates if the cell covers multiple columns. |
| **Notes** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 73](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L73) |
---
### [rowIndexRange](#rowindexrange)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.rowIndexRange ` |
| **Type** | Field |
| **Description** | Returns a table of `{len,loc}`, which indicates if the cell covers multiple rows. |
| **Notes** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 80](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L80) |
---
### [selected](#selected)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.selected ` |
| **Type** | Field |
| **Description** | Indicates if the cell is currently selected. |
| **Notes** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 87](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L87) |
---
### [value](#value)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.value ` |
| **Type** | Field |
| **Description** | The cell value, if it is a string. |
| **Notes** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 115](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L115) |
---
#### Methods
### [textValueIs](#textvalueis)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `cp.ui.Cell.textValueIs(value) -> boolean` |
| **Type** | Method |
| **Description** | Checks if the cell's text value equals `value`. |
| **Parameters** | - `value` - The text value to compare.
|
| **Returns** | - `true` if the cell text value equals the provided `value`.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/extensions/cp/ui/Cell.lua line 122](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/ui/Cell.lua#L122) |
---
---