Docs For Class PTextArea

Class PTextArea

PComponent
   |
   --PTextComponent
      |
      --PTextArea

Classes extended from PTextArea:
Location: Program_Root/swing/PTextArea.php

Package: swing
Since: Japha 1.0
Author: Ryan Gantt @

Class Variable Summary

Inherited Class Variable Summary

Method Summary

Inherited Method Summary

Inherited From Class PTextComponent

Variable Detail

Method Detail

void genArea()

Usage: genArea ( )

Creates a new text area based on the default values and the styles from the superclass

Parameters

Info

Access: public

int getCols()

Usage: getCols ( )
```
Returns the number of columns (the width) of the current text area
```
Parameters
Info
- Return: The number of columns in the text area
- Access: public
int getRows()

Usage: getRows ( )
```
Returns the number of rows (the height) of the current text area
```
Parameters
Info
- Return: The number of rows in the text area
- Access: public
StringBuffer paint()

Usage: paint ( [$return = false] )
```
Paints the component to the screen, or returns its value to be drawn later
```
Parameters
- return $return - set to true if you want to return the component instead of displaying it @
Info
- Return: for use later on
void setCols()

Usage: setCols ( $cols )
```
Mutates the number of columns (and thus, the width) of the text area
```
Parameters
- cols $cols - The new width of the text area @
Info
- Throws: ArgumentDataTypeException if the passed value is not of type integer
- Access: public
void setRows()

Usage: setRows ( $rows )
```
Mutates the number of rows (and thus, the height) of the text area
```
Parameters
- rows $rows - The new height of the text area @
Info
- Throws: ArgumentDataTypeException if the passed value is not of type integer
- Access: public
void __construct()

Usage: __construct ( $name, $rows, $cols, $value )

Overrides: PTextComponent::__construct()
```
Sets the default options for the textarea
```
Parameters
- name $name - The name of the component @
- rows $rows - The height of the text area @
- cols $cols - The width of the text area @
- value $value - The default text value of the text area
Info
- Access: public