CIP JAVA documentation for class "com.ptc.uifc.uifcTree.Tree"

Interface Tree

package com.ptc.uifc.uifcTree; public interface Tree extends com.ptc.uifc.uifcSelection.Selection

Description

Method Summary
`void`	`AddActionListener (TreeListener listener)`
`boolean`	`CanDrawContentDisabled ()`
`boolean`	`CanPopupHelpText ()`
`boolean`	`CanRedraw ()`
`void`	`CreateTimer (TreeTimer timer, String timerName, boolean writeInTrail)`
`void`	`DeleteChild (String name)`
`void`	`DeleteColumnsByIndex (intseq columns)`
`void`	`DeleteColumnsByName (stringseq names)`
`void`	`DeleteItemByName (String name)`
`void`	`DeleteItemsByName (stringseq names)`
`void`	`DeletePopupMenu ()`
`boolean`	`DoesActivateOnReturn ()`
`boolean`	`DoesAllowHover ()`
`boolean`	`DoesAutoCheck ()`
`boolean`	`DoesAutoOpenAndClose ()`
`boolean`	`DoesHighlightOnDragMove ()`
`boolean`	`DoesHorzScrollOnFocus ()`
`boolean`	`DoesItemExist (String name)`
`boolean`	`DoesItemSelectOnRMB ()`
`boolean`	`DoesItemSelectWhenSelected ()`
`boolean`	`DoesScrollOnKeyboardInput ()`
`Color`	`GetAlternateRowColor ()`
`intseq`	`GetColumnWidthArray ()`
`Point`	`GetCursorPosition ()`
`String`	`GetDragCursorImage ()`
`String`	`GetDragItemName ()`
`String`	`GetDragNotValidCursorImage ()`
`String`	`GetDropItemName ()`
`String`	`GetFocusItemName ()`
`Dimension`	`GetFrameMinimumSize ()`
`Point`	`GetFrameOrigin ()`
`Rectangle`	`GetFrameRectangle ()`
`Dimension`	`GetFrameSize ()`
`int`	`GetHeight ()`
`int`	`GetImageHeight ()`
`int`	`GetImageWidth ()`
`int`	`GetItemSelectionDelay ()`
`SelectionPolicy`	`GetItemSelectionPolicy ()`
`stringseq`	`GetItemsOfType (String name)`
`int`	`GetMinimumHeight ()`
`int`	`GetMinimumWidth ()`
`String`	`GetMixedStateImage ()`
`void`	`GetMostRecentCellName (stringseq node, stringseq column)`
`String`	`GetMostRecentItemName ()`
`stringseq`	`GetNodeTypeCloseImageArray ()`
`stringseq`	`GetNodeTypeHelpTextArray ()`
`stringseq`	`GetNodeTypeNameArray ()`
`stringseq`	`GetNodeTypeOpenImageArray ()`
`stringseq`	`GetNodeTypePrefixArray ()`
`stringseq`	`GetNodeTypeSuffixArray ()`
`String`	`GetOpenCloseItemName ()`
`Rectangle`	`GetRectangleOfMonitor ()`
`String`	`GetRootItemName ()`
`Point`	`GetScreenOrigin ()`
`Rectangle`	`GetScreenRectangle ()`
`ScrollBarPosition`	`GetScrollBarPosition ()`
`stringseq`	`GetSelectedItemNameArray ()`
`String`	`GetSetStateImage ()`
`TreeGravity`	`GetTreeGravity ()`
`LabelAlignment`	`GetTreeHeaderTextAlignment ()`
`TreeType`	`GetTreeType ()`
`String`	`GetUnsetStateImage ()`
`stringseq`	`GetViewableItemNameArray (String first, String last)`
`stringseq`	`GetViewableItemNameArray ()`
`int`	`GetWidth ()`
`boolean`	`HasBorder ()`
`boolean`	`HasScrollBarsWhenNeeded ()`
`int`	`InsertChild (Component component)`
`void`	`InsertItem (TreeItem treeitem, ItemPositionData item_pos_data)`
`int`	`InsertPopupMenu (Component component)`
`boolean`	`IsRootItemVisible ()`
`boolean`	`IsSelectionVisible ()`
`boolean`	`IsValidDragSite ()`
`void`	`MoveColumnsByIndex (int column, intseq columns)`
`void`	`MoveColumnsByName (String column, stringseq names)`
`void`	`PushAction (TreeAction action)`
`void`	`SetActivateOnReturn (boolean flag)`
`void`	`SetAllowHover (boolean flag)`
`void`	`SetAlternateRowColor (Color color)`
`void`	`SetAutoCheck (boolean flag)`
`void`	`SetAutoOpenAndClose (boolean flag)`
`void`	`SetCanDrawContentDisabled (boolean flag)`
`void`	`SetCanPopupHelpText (boolean flag)`
`void`	`SetCanRedraw (boolean flag)`
`void`	`SetColumnWidthArray (intseq values)`
`void`	`SetDragCursorImage (String value)`
`void`	`SetDragNotValidCursorImage (String value)`
`void`	`SetFocusItemName (String value)`
`void`	`SetFrameOrigin (Point value)`
`void`	`SetFrameRectangle (Rectangle rect)`
`void`	`SetFrameSize (Dimension value)`
`void`	`SetHasBorder (boolean flag)`
`void`	`SetHasScrollBarsWhenNeeded (boolean flag)`
`void`	`SetHeight (int value)`
`void`	`SetHighlightOnDragMove (boolean flag)`
`void`	`SetHorzScrollOnFocus (boolean flag)`
`void`	`SetImageHeight (int value)`
`void`	`SetImageWidth (int value)`
`void`	`SetItemSelectionDelay (int value)`
`void`	`SetItemSelectionPolicy (SelectionPolicy value)`
`void`	`SetItemSelectOnRMB (boolean flag)`
`void`	`SetItemSelectWhenSelected (boolean flag)`
`void`	`SetMinimumHeight (int value)`
`void`	`SetMinimumWidth (int value)`
`void`	`SetMixedStateImage (String value)`
`void`	`SetNodeTypeCloseImageArray (stringseq values)`
`void`	`SetNodeTypeHelpTextArray (stringseq values)`
`void`	`SetNodeTypeNameArray (stringseq values)`
`void`	`SetNodeTypeOpenImageArray (stringseq values)`
`void`	`SetNodeTypePrefixArray (stringseq values)`
`void`	`SetNodeTypeSuffixArray (stringseq values)`
`void`	`SetRootItemName (String value)`
`void`	`SetRootItemVisible (boolean flag)`
`void`	`SetScrollBarPosition (ScrollBarPosition value)`
`void`	`SetScrollOnKeyboardInput (boolean flag)`
`void`	`SetSelectedItemNameArray (stringseq values)`
`void`	`SetSelectionVisible (boolean flag)`
`void`	`SetSetStateImage (String value)`
`void`	`SetTreeGravity (TreeGravity value)`
`void`	`SetTreeHeaderTextAlignment (LabelAlignment value)`
`void`	`SetTreeType (TreeType value)`
`void`	`SetUnsetStateImage (String value)`
`void`	`SetValidDragSite (boolean flag)`
`void`	`SetWidth (int value)`
`void`	`StartTimer (String timerName, int duration)`
`void`	`StopTimer (String timerName)`

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.uifcSelection.Selection`
`IsInMixedState`, `SetInMixedState`, `GetTextFormat`, `SetTextFormat`, `GetFontName`, `SetFontName`, `GetFontClass`, `SetFontClass`, `GetFontSize`, `SetFontSize`, `IsEnabled`, `SetEnabled`, `GetHelpText`, `SetHelpText`, `GetFontStyle`, `SetFontStyle`

Method Detail

DeleteColumnsByIndex

void DeleteColumnsByIndex (intseq columns)

Parameters:

columns

Returns:

GetFrameOrigin

Point GetFrameOrigin ()

Returns:

GetMostRecentCellName

void GetMostRecentCellName (stringseq node, stringseq column)

Parameters:

node
column

Returns:

GetItemsOfType

stringseq GetItemsOfType (String name)

Parameters:

name

Returns:

GetViewableItemNameArray

stringseq GetViewableItemNameArray (String first, String last)

Parameters:

first
last

Returns:

InsertPopupMenu

int InsertPopupMenu (Component component)

Parameters:

component

Returns:

GetFrameSize

Dimension GetFrameSize ()

Returns:

InsertChild

int InsertChild (Component component)

Parameters:

component

Returns:

DeleteColumnsByName

void DeleteColumnsByName (stringseq names)

Parameters:

names

Returns:

GetFrameRectangle

Rectangle GetFrameRectangle ()

Returns:

DeleteChild

void DeleteChild (String name)

Parameters:

name

Returns:

DeleteItemByName

void DeleteItemByName (String name)

Parameters:

name

Returns:

GetCursorPosition

Point GetCursorPosition ()

Returns:

DeletePopupMenu

void DeletePopupMenu ()

Returns:

InsertItem

void InsertItem (TreeItem treeitem, ItemPositionData item_pos_data)

Parameters:

treeitem
item_pos_data

Returns:

GetScreenOrigin

Point GetScreenOrigin ()

Returns:

SetFrameSize

void SetFrameSize (Dimension value)

Parameters:

value

Returns:

MoveColumnsByIndex

void MoveColumnsByIndex (int column, intseq columns)

Parameters:

column
columns

Returns:

DeleteItemsByName

void DeleteItemsByName (stringseq names)

Parameters:

names

Returns:

SetFrameOrigin

void SetFrameOrigin (Point value)

Parameters:

value

Returns:

GetFrameMinimumSize

Dimension GetFrameMinimumSize ()

Returns:

DoesItemExist

boolean DoesItemExist (String name)

Parameters:

name

Returns:

GetScreenRectangle

Rectangle GetScreenRectangle ()

Returns:

MoveColumnsByName

void MoveColumnsByName (String column, stringseq names)

Parameters:

column
names

Returns:

SetFrameRectangle

void SetFrameRectangle (Rectangle rect)

Parameters:

rect

Returns:

GetRectangleOfMonitor

Rectangle GetRectangleOfMonitor ()

Returns:

GetColumnWidthArray

intseq GetColumnWidthArray ()

Returns:

SetColumnWidthArray

void SetColumnWidthArray (intseq values)

Parameters:

values

Returns:

DoesActivateOnReturn

boolean DoesActivateOnReturn ()

Returns:

SetActivateOnReturn

void SetActivateOnReturn (boolean flag)

Parameters:

flag

Returns:

GetSelectedItemNameArray

stringseq GetSelectedItemNameArray ()

Returns:

SetSelectedItemNameArray

void SetSelectedItemNameArray (stringseq values)

Parameters:

values

Returns:

GetWidth

int GetWidth ()

Returns:

SetWidth

void SetWidth (int value)

Parameters:

value

Returns:

DoesAllowHover

boolean DoesAllowHover ()

Returns:

SetAllowHover

void SetAllowHover (boolean flag)

Parameters:

flag

Returns:

GetMinimumWidth

int GetMinimumWidth ()

Returns:

SetMinimumWidth

void SetMinimumWidth (int value)

Parameters:

value

Returns:

GetMinimumHeight

int GetMinimumHeight ()

Returns:

SetMinimumHeight

void SetMinimumHeight (int value)

Parameters:

value

Returns:

GetNodeTypeSuffixArray

stringseq GetNodeTypeSuffixArray ()

Returns:

SetNodeTypeSuffixArray

void SetNodeTypeSuffixArray (stringseq values)

Parameters:

values

Returns:

GetMixedStateImage

String GetMixedStateImage ()

Returns:

SetMixedStateImage

void SetMixedStateImage (String value)

Parameters:

value

Returns:

CanDrawContentDisabled

boolean CanDrawContentDisabled ()

Returns:

SetCanDrawContentDisabled

void SetCanDrawContentDisabled (boolean flag)

Parameters:

flag

Returns:

GetNodeTypePrefixArray

stringseq GetNodeTypePrefixArray ()

Returns:

SetNodeTypePrefixArray

void SetNodeTypePrefixArray (stringseq values)

Parameters:

values

Returns:

GetDragItemName

String GetDragItemName ()

Returns:

GetRootItemName

String GetRootItemName ()

Returns:

SetRootItemName

void SetRootItemName (String value)

Parameters:

value

Returns:

HasScrollBarsWhenNeeded

boolean HasScrollBarsWhenNeeded ()

Returns:

SetHasScrollBarsWhenNeeded

void SetHasScrollBarsWhenNeeded (boolean flag)

Parameters:

flag

Returns:

GetDragCursorImage

String GetDragCursorImage ()

Returns:

SetDragCursorImage

void SetDragCursorImage (String value)

Parameters:

value

Returns:

GetFocusItemName

String GetFocusItemName ()

Returns:

SetFocusItemName

void SetFocusItemName (String value)

Parameters:

value

Returns:

DoesHorzScrollOnFocus

boolean DoesHorzScrollOnFocus ()

Returns:

SetHorzScrollOnFocus

void SetHorzScrollOnFocus (boolean flag)

Parameters:

flag

Returns:

GetViewableItemNameArray

stringseq GetViewableItemNameArray ()

Returns:

GetTreeType

TreeType GetTreeType ()

Returns:

SetTreeType

void SetTreeType (TreeType value)

Parameters:

value

Returns:

DoesHighlightOnDragMove

boolean DoesHighlightOnDragMove ()

Returns:

SetHighlightOnDragMove

void SetHighlightOnDragMove (boolean flag)

Parameters:

flag

Returns:

GetDragNotValidCursorImage

String GetDragNotValidCursorImage ()

Returns:

SetDragNotValidCursorImage

void SetDragNotValidCursorImage (String value)

Parameters:

value

Returns:

GetTreeHeaderTextAlignment

LabelAlignment GetTreeHeaderTextAlignment ()

Returns:

SetTreeHeaderTextAlignment

void SetTreeHeaderTextAlignment (LabelAlignment value)

Parameters:

value

Returns:

GetDropItemName

String GetDropItemName ()

Returns:

GetNodeTypeCloseImageArray

stringseq GetNodeTypeCloseImageArray ()

Returns:

SetNodeTypeCloseImageArray

void SetNodeTypeCloseImageArray (stringseq values)

Parameters:

values

Returns:

GetAlternateRowColor

Color GetAlternateRowColor ()

Returns:

SetAlternateRowColor

void SetAlternateRowColor (Color color)

Parameters:

color

Returns:

CanRedraw

boolean CanRedraw ()

Returns:

SetCanRedraw

void SetCanRedraw (boolean flag)

Parameters:

flag

Returns:

IsValidDragSite

boolean IsValidDragSite ()

Returns:

SetValidDragSite

void SetValidDragSite (boolean flag)

Parameters:

flag

Returns:

GetImageWidth

int GetImageWidth ()

Returns:

SetImageWidth

void SetImageWidth (int value)

Parameters:

value

Returns:

GetScrollBarPosition

ScrollBarPosition GetScrollBarPosition ()

Returns:

SetScrollBarPosition

void SetScrollBarPosition (ScrollBarPosition value)

Parameters:

value

Returns:

GetNodeTypeHelpTextArray

stringseq GetNodeTypeHelpTextArray ()

Returns:

SetNodeTypeHelpTextArray

void SetNodeTypeHelpTextArray (stringseq values)

Parameters:

values

Returns:

DoesItemSelectOnRMB

boolean DoesItemSelectOnRMB ()

Returns:

SetItemSelectOnRMB

void SetItemSelectOnRMB (boolean flag)

Parameters:

flag

Returns:

DoesAutoOpenAndClose

boolean DoesAutoOpenAndClose ()

Returns:

SetAutoOpenAndClose

void SetAutoOpenAndClose (boolean flag)

Parameters:

flag

Returns:

DoesItemSelectWhenSelected

boolean DoesItemSelectWhenSelected ()

Returns:

SetItemSelectWhenSelected

void SetItemSelectWhenSelected (boolean flag)

Parameters:

flag

Returns:

GetItemSelectionDelay

int GetItemSelectionDelay ()

Returns:

SetItemSelectionDelay

void SetItemSelectionDelay (int value)

Parameters:

value

Returns:

GetNodeTypeOpenImageArray

stringseq GetNodeTypeOpenImageArray ()

Returns:

SetNodeTypeOpenImageArray

void SetNodeTypeOpenImageArray (stringseq values)

Parameters:

values

Returns:

CanPopupHelpText

boolean CanPopupHelpText ()

Returns:

SetCanPopupHelpText

void SetCanPopupHelpText (boolean flag)

Parameters:

flag

Returns:

GetImageHeight

int GetImageHeight ()

Returns:

SetImageHeight

void SetImageHeight (int value)

Parameters:

value

Returns:

IsSelectionVisible

boolean IsSelectionVisible ()

Returns:

SetSelectionVisible

void SetSelectionVisible (boolean flag)

Parameters:

flag

Returns:

DoesAutoCheck

boolean DoesAutoCheck ()

Returns:

SetAutoCheck

void SetAutoCheck (boolean flag)

Parameters:

flag

Returns:

GetUnsetStateImage

String GetUnsetStateImage ()

Returns:

SetUnsetStateImage

void SetUnsetStateImage (String value)

Parameters:

value

Returns:

GetMostRecentItemName

String GetMostRecentItemName ()

Returns:

GetSetStateImage

String GetSetStateImage ()

Returns:

SetSetStateImage

void SetSetStateImage (String value)

Parameters:

value

Returns:

GetHeight

int GetHeight ()

Returns:

SetHeight

void SetHeight (int value)

Parameters:

value

Returns:

GetItemSelectionPolicy

SelectionPolicy GetItemSelectionPolicy ()

Returns:

SetItemSelectionPolicy

void SetItemSelectionPolicy (SelectionPolicy value)

Parameters:

value

Returns:

DoesScrollOnKeyboardInput

boolean DoesScrollOnKeyboardInput ()

Returns:

SetScrollOnKeyboardInput

void SetScrollOnKeyboardInput (boolean flag)

Parameters:

flag

Returns:

GetTreeGravity

TreeGravity GetTreeGravity ()

Returns:

SetTreeGravity

void SetTreeGravity (TreeGravity value)

Parameters:

value

Returns:

GetNodeTypeNameArray

stringseq GetNodeTypeNameArray ()

Returns:

SetNodeTypeNameArray

void SetNodeTypeNameArray (stringseq values)

Parameters:

values

Returns:

GetOpenCloseItemName

String GetOpenCloseItemName ()

Returns:

HasBorder

boolean HasBorder ()

Returns:

SetHasBorder

void SetHasBorder (boolean flag)

Parameters:

flag

Returns:

IsRootItemVisible

boolean IsRootItemVisible ()

Returns:

SetRootItemVisible

void SetRootItemVisible (boolean flag)

Parameters:

flag

Returns:

AddActionListener

void AddActionListener (TreeListener listener)

Parameters:

listener

Returns:

PushAction

void PushAction (TreeAction action)

Parameters:

action

Returns:

CreateTimer

void CreateTimer (TreeTimer 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: