CIP JAVA documentation for class "com.ptc.uifc.uifcTextArea.TextArea"

Interface TextArea

package com.ptc.uifc.uifcTextArea; public interface TextArea extends com.ptc.uifc.uifcText.Text

Description

Method Summary
`void`	`AddActionListener (TextAreaListener listener)`
`boolean`	`CanDrawContentDisabled ()`
`boolean`	`CanRedraw ()`
`boolean`	`CanWrap ()`
`void`	`CopySelectionToClipboard ()`
`void`	`CreateTimer (TextAreaTimer timer, String timerName, boolean writeInTrail)`
`void`	`CutSelectionToClipboard ()`
`void`	`DeletePopupMenu ()`
`boolean`	`DoesActivateOnReturn ()`
`boolean`	`DoesAllowReturnInput ()`
`boolean`	`DoesAllowTabInput ()`
`boolean`	`DoesAutoCompleteReplace ()`
`boolean`	`DoesHighlightOnFocus ()`
`boolean`	`DoesSizeByContents ()`
`int`	`GetAutoCompleteLength ()`
`stringseq`	`GetAutoCompleteTextArray ()`
`int`	`GetCaretPosition ()`
`Dimension`	`GetFrameMinimumSize ()`
`Point`	`GetFrameOrigin ()`
`Rectangle`	`GetFrameRectangle ()`
`Dimension`	`GetFrameSize ()`
`int`	`GetHeight ()`
`Key`	`GetKeyPressed ()`
`int`	`GetLineCount ()`
`int`	`GetLineLength (int line)`
`int`	`GetLineOffset (int line)`
`String`	`GetLineText (int line)`
`int`	`GetMaximumWidth ()`
`int`	`GetMinimumHeight ()`
`int`	`GetMinimumWidth ()`
`int`	`GetPasswordCharacter ()`
`String`	`GetPrompt ()`
`ReadingOrder`	`GetReadingOrder ()`
`Rectangle`	`GetRectangleOfMonitor ()`
`Point`	`GetScreenOrigin ()`
`Rectangle`	`GetScreenRectangle ()`
`ScrollBarPosition`	`GetScrollBarPosition ()`
`Point`	`GetSelectedRange ()`
`String`	`GetSelectedText ()`
`String`	`GetStringValue ()`
`TextGravity`	`GetTextGravity ()`
`String`	`GetTextValue ()`
`int`	`GetTextValueMaximumLength ()`
`int`	`GetUndoBufferSize ()`
`String`	`GetWideStringValue ()`
`boolean`	`HasBorder ()`
`boolean`	`HasScrollBarsWhenNeeded ()`
`boolean`	`HasTextChanged ()`
`void`	`InputBackspaceKeys (int count)`
`void`	`InputDeleteKeys (int count)`
`int`	`InsertPopupMenu (Component component)`
`void`	`InsertTextIntoSelection (String text)`
`boolean`	`IsAutoCompleteCaseSensitive ()`
`boolean`	`IsCaretVisible ()`
`boolean`	`IsHeightFixed ()`
`boolean`	`IsPassword ()`
`boolean`	`IsReadOnly ()`
`boolean`	`IsSelectionVisible ()`
`boolean`	`IsWidthFixed ()`
`void`	`PasteClipboardToSelection ()`
`void`	`PushAction (TextAreaAction action)`
`void`	`RedoLastUndo ()`
`void`	`ReplaceLineWithText (int line, String text)`
`void`	`ReplaceSelectionWithText (int start, int end, String text)`
`void`	`SelectAll ()`
`void`	`SetActivateOnReturn (boolean flag)`
`void`	`SetAllowReturnInput (boolean flag)`
`void`	`SetAllowTabInput (boolean flag)`
`void`	`SetAutoCompleteCaseSensitive (boolean flag)`
`void`	`SetAutoCompleteLength (int value)`
`void`	`SetAutoCompleteReplace (boolean flag)`
`void`	`SetAutoCompleteTextArray (stringseq values)`
`void`	`SetCanDrawContentDisabled (boolean flag)`
`void`	`SetCanRedraw (boolean flag)`
`void`	`SetCanWrap (boolean flag)`
`void`	`SetCaretPosition (int position)`
`void`	`SetCaretVisible (boolean flag)`
`void`	`SetFrameOrigin (Point value)`
`void`	`SetFrameRectangle (Rectangle rect)`
`void`	`SetFrameSize (Dimension value)`
`void`	`SetHasBorder (boolean flag)`
`void`	`SetHasScrollBarsWhenNeeded (boolean flag)`
`void`	`SetHasTextChanged (boolean flag)`
`void`	`SetHeight (int value)`
`void`	`SetHeightFixed (boolean flag)`
`void`	`SetHighlightOnFocus (boolean flag)`
`void`	`SetKeyPressed (Key key)`
`void`	`SetMaximumWidth (int value)`
`void`	`SetMinimumHeight (int value)`
`void`	`SetMinimumWidth (int value)`
`void`	`SetPassword (boolean flag)`
`void`	`SetPasswordCharacter (int value)`
`void`	`SetPrompt (String value)`
`void`	`SetReadingOrder (ReadingOrder value)`
`void`	`SetReadOnly (boolean flag)`
`void`	`SetScrollBarPosition (ScrollBarPosition value)`
`void`	`SetSelectedRange (Point value)`
`void`	`SetSelectionVisible (boolean flag)`
`void`	`SetSizeByContents (boolean flag)`
`void`	`SetStringValue (String value)`
`void`	`SetTextGravity (TextGravity value)`
`void`	`SetTextValue (String value)`
`void`	`SetTextValueMaximumLength (int value)`
`void`	`SetUndoBufferSize (int value)`
`void`	`SetWideStringValue (String value)`
`void`	`SetWidthFixed (boolean flag)`
`void`	`StartTimer (String timerName, int duration)`
`void`	`StopTimer (String timerName)`
`void`	`UndoLastChange ()`

Methods Inherited from Interface `com.ptc.uifc.uifcComponent.Component`
`GetDialog`, `GetComponent`, `CreateInParent`, `AddPopupMenu`, `IsVisible`, `SetVisible`, `GetComponentClass`, `GetComponentClassName`, `IsAlwaysAtFront`, `SetAlwaysAtFront`, `GetBackgroundColor`, `SetBackgroundColor`, `IsAttachedAtBottom`, `SetAttachedAtBottom`, `GetBottomOffset`, `SetBottomOffset`, `GetCursorImage`, `SetCursorImage`, `GetTextColor`, `SetTextColor`, `GetHelpTextAlignment`, `SetHelpTextAlignment`, `GetHelpTextWidth`, `SetHelpTextWidth`, `GetHelpTextOriginX`, `SetHelpTextOriginX`, `GetHelpTextOriginY`, `SetHelpTextOriginY`, `CanInheritPopupMenu`, `SetCanInheritPopupMenu`, `IsAttachedAtLeft`, `SetAttachedAtLeft`, `GetLeftOffset`, `SetLeftOffset`, `DoesReserveSpace`, `SetReserveSpace`, `GetParentName`, `GetPopupMenuName`, `SetPopupMenuName`, `CanPopupMenuWhenDisabled`, `SetCanPopupMenuWhenDisabled`, `IsAttachedAtRight`, `SetAttachedAtRight`, `GetRightOffset`, `SetRightOffset`, `IsAttachedAtTop`, `SetAttachedAtTop`, `GetTopOffset`, `SetTopOffset`, `IsValidDropSite`, `SetValidDropSite`, `GetValidDropTypeFlags`, `SetValidDropTypeFlags`, `GetChildNameArray`, `DoesAllowTrailRecording`, `SetAllowTrailRecording`, `CanReduceHeight`, `SetCanReduceHeight`, `CanReduceWidth`, `SetCanReduceWidth`

Methods Inherited from Interface com.ptc.uifc.uifcComponent.Component

GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Methods Inherited from Interface `com.ptc.uifc.uifcText.Text`
`GetFontName`, `SetFontName`, `GetFontClass`, `SetFontClass`, `GetFontSize`, `SetFontSize`, `IsEnabled`, `SetEnabled`, `GetHelpText`, `SetHelpText`, `GetWidth`, `SetWidth`, `GetFontStyle`, `SetFontStyle`

Method Detail

GetFrameOrigin

Point GetFrameOrigin ()

Returns:

GetLineOffset

int GetLineOffset (int line)

Parameters:

line

Returns:

GetCaretPosition

int GetCaretPosition ()

Returns:

InputBackspaceKeys

void InputBackspaceKeys (int count)

Parameters:

count

Returns:

ReplaceSelectionWithText

void ReplaceSelectionWithText (int start, int end, String text)

Parameters:

start
end
text

Returns:

InsertTextIntoSelection

void InsertTextIntoSelection (String text)

Parameters:

text

Returns:

GetLineLength

int GetLineLength (int line)

Parameters:

line

Returns:

InsertPopupMenu

int InsertPopupMenu (Component component)

Parameters:

component

Returns:

UndoLastChange

void UndoLastChange ()

Returns:

SetSelectedRange

void SetSelectedRange (Point value)

Parameters:

value

Returns:

ReplaceLineWithText

void ReplaceLineWithText (int line, String text)

Parameters:

line
text

Returns:

PasteClipboardToSelection

void PasteClipboardToSelection ()

Returns:

GetFrameSize

Dimension GetFrameSize ()

Returns:

DeletePopupMenu

void DeletePopupMenu ()

Returns:

SelectAll

void SelectAll ()

Returns:

GetScreenOrigin

Point GetScreenOrigin ()

Returns:

CopySelectionToClipboard

void CopySelectionToClipboard ()

Returns:

CutSelectionToClipboard

void CutSelectionToClipboard ()

Returns:

SetFrameSize

void SetFrameSize (Dimension value)

Parameters:

value

Returns:

InputDeleteKeys

void InputDeleteKeys (int count)

Parameters:

count

Returns:

GetFrameRectangle

Rectangle GetFrameRectangle ()

Returns:

GetLineCount

int GetLineCount ()

Returns:

SetCaretPosition

void SetCaretPosition (int position)

Parameters:

position

Returns:

SetFrameOrigin

void SetFrameOrigin (Point value)

Parameters:

value

Returns:

GetSelectedRange

Point GetSelectedRange ()

Returns:

GetFrameMinimumSize

Dimension GetFrameMinimumSize ()

Returns:

GetLineText

String GetLineText (int line)

Parameters:

line

Returns:

GetScreenRectangle

Rectangle GetScreenRectangle ()

Returns:

SetFrameRectangle

void SetFrameRectangle (Rectangle rect)

Parameters:

rect

Returns:

RedoLastUndo

void RedoLastUndo ()

Returns:

GetSelectedText

String GetSelectedText ()

Returns:

GetRectangleOfMonitor

Rectangle GetRectangleOfMonitor ()

Returns:

DoesActivateOnReturn

boolean DoesActivateOnReturn ()

Returns:

SetActivateOnReturn

void SetActivateOnReturn (boolean flag)

Parameters:

flag

Returns:

GetMinimumWidth

int GetMinimumWidth ()

Returns:

SetMinimumWidth

void SetMinimumWidth (int value)

Parameters:

value

Returns:

GetPrompt

String GetPrompt ()

Returns:

SetPrompt

void SetPrompt (String value)

Parameters:

value

Returns:

HasBorder

boolean HasBorder ()

Returns:

SetHasBorder

void SetHasBorder (boolean flag)

Parameters:

flag

Returns:

GetMinimumHeight

int GetMinimumHeight ()

Returns:

SetMinimumHeight

void SetMinimumHeight (int value)

Parameters:

value

Returns:

DoesAllowReturnInput

boolean DoesAllowReturnInput ()

Returns:

SetAllowReturnInput

void SetAllowReturnInput (boolean flag)

Parameters:

flag

Returns:

CanDrawContentDisabled

boolean CanDrawContentDisabled ()

Returns:

SetCanDrawContentDisabled

void SetCanDrawContentDisabled (boolean flag)

Parameters:

flag

Returns:

IsHeightFixed

boolean IsHeightFixed ()

Returns:

SetHeightFixed

void SetHeightFixed (boolean flag)

Parameters:

flag

Returns:

HasTextChanged

boolean HasTextChanged ()

Returns:

SetHasTextChanged

void SetHasTextChanged (boolean flag)

Parameters:

flag

Returns:

GetStringValue

String GetStringValue ()

Returns:

SetStringValue

void SetStringValue (String value)

Parameters:

value

Returns:

HasScrollBarsWhenNeeded

boolean HasScrollBarsWhenNeeded ()

Returns:

SetHasScrollBarsWhenNeeded

void SetHasScrollBarsWhenNeeded (boolean flag)

Parameters:

flag

Returns:

GetKeyPressed

Key GetKeyPressed ()

Returns:

SetKeyPressed

void SetKeyPressed (Key key)

Parameters:

key

Returns:

DoesSizeByContents

boolean DoesSizeByContents ()

Returns:

SetSizeByContents

void SetSizeByContents (boolean flag)

Parameters:

flag

Returns:

IsWidthFixed

boolean IsWidthFixed ()

Returns:

SetWidthFixed

void SetWidthFixed (boolean flag)

Parameters:

flag

Returns:

CanWrap

boolean CanWrap ()

Returns:

SetCanWrap

void SetCanWrap (boolean flag)

Parameters:

flag

Returns:

DoesHighlightOnFocus

boolean DoesHighlightOnFocus ()

Returns:

SetHighlightOnFocus

void SetHighlightOnFocus (boolean flag)

Parameters:

flag

Returns:

IsPassword

boolean IsPassword ()

Returns:

SetPassword

void SetPassword (boolean flag)

Parameters:

flag

Returns:

GetReadingOrder

ReadingOrder GetReadingOrder ()

Returns:

SetReadingOrder

void SetReadingOrder (ReadingOrder value)

Parameters:

value

Returns:

GetUndoBufferSize

int GetUndoBufferSize ()

Returns:

SetUndoBufferSize

void SetUndoBufferSize (int value)

Parameters:

value

Returns:

GetAutoCompleteLength

int GetAutoCompleteLength ()

Returns:

SetAutoCompleteLength

void SetAutoCompleteLength (int value)

Parameters:

value

Returns:

IsCaretVisible

boolean IsCaretVisible ()

Returns:

SetCaretVisible

void SetCaretVisible (boolean flag)

Parameters:

flag

Returns:

GetScrollBarPosition

ScrollBarPosition GetScrollBarPosition ()

Returns:

SetScrollBarPosition

void SetScrollBarPosition (ScrollBarPosition value)

Parameters:

value

Returns:

GetMaximumWidth

int GetMaximumWidth ()

Returns:

SetMaximumWidth

void SetMaximumWidth (int value)

Parameters:

value

Returns:

GetTextValueMaximumLength

int GetTextValueMaximumLength ()

Returns:

SetTextValueMaximumLength

void SetTextValueMaximumLength (int value)

Parameters:

value

Returns:

IsSelectionVisible

boolean IsSelectionVisible ()

Returns:

SetSelectionVisible

void SetSelectionVisible (boolean flag)

Parameters:

flag

Returns:

CanRedraw

boolean CanRedraw ()

Returns:

SetCanRedraw

void SetCanRedraw (boolean flag)

Parameters:

flag

Returns:

GetAutoCompleteTextArray

stringseq GetAutoCompleteTextArray ()

Returns:

SetAutoCompleteTextArray

void SetAutoCompleteTextArray (stringseq values)

Parameters:

values

Returns:

GetHeight

int GetHeight ()

Returns:

SetHeight

void SetHeight (int value)

Parameters:

value

Returns:

GetPasswordCharacter

int GetPasswordCharacter ()

Returns:

SetPasswordCharacter

void SetPasswordCharacter (int value)

Parameters:

value

Returns:

IsAutoCompleteCaseSensitive

boolean IsAutoCompleteCaseSensitive ()

Returns:

SetAutoCompleteCaseSensitive

void SetAutoCompleteCaseSensitive (boolean flag)

Parameters:

flag

Returns:

GetTextGravity

TextGravity GetTextGravity ()

Returns:

SetTextGravity

void SetTextGravity (TextGravity value)

Parameters:

value

Returns:

DoesAllowTabInput

boolean DoesAllowTabInput ()

Returns:

SetAllowTabInput

void SetAllowTabInput (boolean flag)

Parameters:

flag

Returns:

GetWideStringValue

String GetWideStringValue ()

Returns:

SetWideStringValue

void SetWideStringValue (String value)

Parameters:

value

Returns:

DoesAutoCompleteReplace

boolean DoesAutoCompleteReplace ()

Returns:

SetAutoCompleteReplace

void SetAutoCompleteReplace (boolean flag)

Parameters:

flag

Returns:

GetTextValue

String GetTextValue ()

Returns:

SetTextValue

void SetTextValue (String value)

Parameters:

value

Returns:

IsReadOnly

boolean IsReadOnly ()

Returns:

SetReadOnly

void SetReadOnly (boolean flag)

Parameters:

flag

Returns:

AddActionListener

void AddActionListener (TextAreaListener listener)

Parameters:

listener

Returns:

PushAction

void PushAction (TextAreaAction action)

Parameters:

action

Returns:

CreateTimer

void CreateTimer (TextAreaTimer timer, String timerName, boolean writeInTrail)

Parameters:

timer
timerName
writeInTrail

Returns:

StartTimer

void StartTimer (String timerName, int duration)

Parameters:

timerName
duration

Returns:

StopTimer

void StopTimer (String timerName)

Parameters:

timerName

Returns: