Library | Package Java Toolkit

Interface List

package com.ptc.uifc.uifcList;

public interface List
  extends com.ptc.uifc.uifcSelection.Selection



Description

 



Method Summary
voidAddActionListener (ListListener listener)
     
booleanCanDrawContentDisabled ()
     
booleanCanRedraw ()
     
booleanCanResizeWhenNeeded ()
     
booleanCanTruncateText ()
     
booleanCanWrap ()
     
voidCreateTimer (ListTimer timer, String timerName, boolean writeInTrail)
     
voidDeleteChild (String name)
     
voidDeleteGroupsByName (stringseq names)
     
voidDeleteItemsByIndex (intseq items)
     
voidDeleteItemsByName (stringseq names)
     
voidDeletePopupMenu ()
     
booleanDoesItemSelectOnRMB ()
     
booleanDoesScrollOnKeyboardInput ()
     
booleanDoesSizeByContents ()
     
ColorGetAlternateRowColor ()
     
StringGetColumnHeaderText ()
     
AlignmentGetColumnHeaderTextAlignment ()
     
intGetContentArrangement ()
     
intGetDefaultColumnWidth ()
     
StringGetDefaultHelpText ()
     
intGetDefaultTabStop ()
     
StringGetDragCursorImage ()
     
StringGetDragGroupName ()
     
StringGetDragItemName ()
     
StringGetDragNotValidCursorImage ()
     
StringGetDropGroupName ()
     
StringGetDropItemName ()
     
stringseqGetEnabledItemNameArray ()
     
StringGetFocusGroupName ()
     
StringGetFocusItemName ()
     
DimensionGetFrameMinimumSize ()
     
PointGetFrameOrigin ()
     
RectangleGetFrameRectangle ()
     
DimensionGetFrameSize ()
     
stringseqGetGroupHelpTextArray ()
     
stringseqGetGroupImageArray ()
     
stringseqGetGroupItemNameArray ()
     
stringseqGetGroupNameArray ()
     
intseqGetGroupOpenArray ()
     
stringseqGetGroupTextArray ()
     
intGetHeight ()
     
intGetHorizontalCells ()
     
intGetImageHeight ()
     
intGetImageWidth ()
     
ColorsGetItemBackgroundColorArray ()
     
intseqGetItemCheckedStateArray ()
     
stringseqGetItemHelpTextArray ()
     
stringseqGetItemImageArray ()
     
stringseqGetItemNameArray ()
     
intGetItemSelectionDelay ()
     
SelectionPolicyGetItemSelectionPolicy ()
     
stringseqGetItemTextArray ()
     
ColorsGetItemTextColorArray ()
     
KeyGetKeyPressed ()
     
ListTypeGetListType ()
     
intGetMaximumWidth ()
     
intGetMinimumHeight ()
     
intGetMinimumWidth ()
     
StringGetMixedStateImage ()
     
StringGetMostRecentGroupName ()
     
StringGetMostRecentItemName ()
     
OrientationGetOrientation ()
     
StringGetPrompt ()
     
RectangleGetRectangleOfMonitor ()
     
PointGetScreenOrigin ()
     
RectangleGetScreenRectangle ()
     
ScrollBarPositionGetScrollBarPosition ()
     
intGetSelectedItemIndex ()
     
StringGetSelectedItemName ()
     
stringseqGetSelectedItemNameArray ()
     
StringGetSetStateImage ()
     
intseqGetTabStopArray ()
     
StringGetUnsetStateImage ()
     
intGetVerticalCells ()
     
intGetWidth ()
     
booleanHasBorder ()
     
booleanHasScrollBarsWhenNeeded ()
     
intInsertChild (Component component)
     
voidInsertGroup (ListGroup listgroup, ItemPositionData item_pos_data)
     
voidInsertGroups (ListGroups listgroups, ItemPositionData posData)
     
voidInsertItem (ListItem listitem, ItemPositionData item_pos_data)
     
voidInsertItems (ListItems listitems, ItemPositionData posData)
     
intInsertPopupMenu (Component component)
     
booleanIsSelectionVisible ()
     
booleanIsValidDragSite ()
     
voidMoveItemsByIndex (int item, intseq items)
     
voidMoveItemsByName (String name, stringseq names)
     
StringOnlyScrollItemNameIntoView ()
     
voidPushAction (ListAction action)
     
voidScrollItemNameIntoView (String value)
     
voidSetAlternateRowColor (Color color)
     
voidSetCanDrawContentDisabled (boolean flag)
     
voidSetCanRedraw (boolean flag)
     
voidSetCanResizeWhenNeeded (boolean flag)
     
voidSetCanTruncateText (boolean flag)
     
voidSetCanWrap (boolean flag)
     
voidSetColumnHeaderText (String value)
     
voidSetColumnHeaderTextAlignment (Alignment value)
     
voidSetContentArrangement (int value)
     
voidSetDefaultColumnWidth (int value)
     
voidSetDefaultHelpText (String value)
     
voidSetDefaultTabStop (int value)
     
voidSetDragCursorImage (String value)
     
voidSetDragGroupName (String value)
     
voidSetDragNotValidCursorImage (String value)
     
voidSetEnabledItemNameArray (stringseq values)
     
voidSetFocusGroupName (String value)
     
voidSetFocusItemName (String value)
     
voidSetFrameOrigin (Point value)
     
voidSetFrameRectangle (Rectangle rect)
     
voidSetFrameSize (Dimension value)
     
voidSetGroupHelpTextArray (stringseq values)
     
voidSetGroupImageArray (stringseq values)
     
voidSetGroupItemNameArray (stringseq values)
     
voidSetGroupNameArray (stringseq values)
     
voidSetGroupOpenArray (intseq values)
     
voidSetGroupTextArray (stringseq values)
     
voidSetHasBorder (boolean flag)
     
voidSetHasScrollBarsWhenNeeded (boolean flag)
     
voidSetHeight (int value)
     
voidSetHorizontalCells (int value)
     
voidSetImageHeight (int value)
     
voidSetImageWidth (int value)
     
voidSetItemBackgroundColorArray (Colors colors)
     
voidSetItemCheckedStateArray (intseq values)
     
voidSetItemHelpTextArray (stringseq values)
     
voidSetItemImageArray (stringseq values)
     
voidSetItemNameArray (stringseq values)
     
voidSetItemSelectionDelay (int value)
     
voidSetItemSelectionPolicy (SelectionPolicy value)
     
voidSetItemSelectOnRMB (boolean flag)
     
voidSetItemTextArray (stringseq values)
     
voidSetItemTextColorArray (Colors colors)
     
voidSetKeyPressed (Key key)
     
voidSetListType (ListType value)
     
voidSetMaximumWidth (int value)
     
voidSetMinimumHeight (int value)
     
voidSetMinimumWidth (int value)
     
voidSetMixedStateImage (String value)
     
voidSetOrientation (Orientation value)
     
voidSetPrompt (String value)
     
voidSetScrollBarPosition (ScrollBarPosition value)
     
voidSetScrollOnKeyboardInput (boolean flag)
     
voidSetSelectedItemIndex (int value)
     
voidSetSelectedItemName (String value)
     
voidSetSelectedItemNameArray (stringseq values)
     
voidSetSelectionVisible (boolean flag)
     
voidSetSetStateImage (String value)
     
voidSetSizeByContents (boolean flag)
     
voidSetTabStopArray (intseq values)
     
voidSetUnsetStateImage (String value)
     
voidSetValidDragSite (boolean flag)
     
voidSetVerticalCells (int value)
     
voidSetWidth (int value)
     
voidStartTimer (String timerName, int duration)
     
voidStopTimer (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.uifcSelection.Selection
IsInMixedState, SetInMixedState, GetTextFormat, SetTextFormat, GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetFontStyle, SetFontStyle

Method Detail

GetFrameOrigin

PointGetFrameOrigin ()


     
Returns:


DeleteGroupsByName

voidDeleteGroupsByName (stringseq names)


     
Parameters:
names
Returns:


InsertGroups

voidInsertGroups (ListGroups listgroups, ItemPositionData posData)


     
Parameters:
listgroups
posData
Returns:


MoveItemsByName

voidMoveItemsByName (String name, stringseq names)


     
Parameters:
name
names
Returns:


InsertPopupMenu

intInsertPopupMenu (Component component)


     
Parameters:
component
Returns:


InsertChild

intInsertChild (Component component)


     
Parameters:
component
Returns:


InsertGroup

voidInsertGroup (ListGroup listgroup, ItemPositionData item_pos_data)


     
Parameters:
listgroup
item_pos_data
Returns:


MoveItemsByIndex

voidMoveItemsByIndex (int item, intseq items)


     
Parameters:
item
items
Returns:


DeleteChild

voidDeleteChild (String name)


     
Parameters:
name
Returns:


GetFrameSize

DimensionGetFrameSize ()


     
Returns:


DeletePopupMenu

voidDeletePopupMenu ()


     
Returns:


InsertItem

voidInsertItem (ListItem listitem, ItemPositionData item_pos_data)


     
Parameters:
listitem
item_pos_data
Returns:


GetScreenOrigin

PointGetScreenOrigin ()


     
Returns:


SetFrameSize

voidSetFrameSize (Dimension value)


     
Parameters:
value
Returns:


InsertItems

voidInsertItems (ListItems listitems, ItemPositionData posData)


     
Parameters:
listitems
posData
Returns:


GetFrameRectangle

RectangleGetFrameRectangle ()


     
Returns:


DeleteItemsByName

voidDeleteItemsByName (stringseq names)


     
Parameters:
names
Returns:


SetFrameOrigin

voidSetFrameOrigin (Point value)


     
Parameters:
value
Returns:


GetFrameMinimumSize

DimensionGetFrameMinimumSize ()


     
Returns:


GetScreenRectangle

RectangleGetScreenRectangle ()


     
Returns:


SetFrameRectangle

voidSetFrameRectangle (Rectangle rect)


     
Parameters:
rect
Returns:


DeleteItemsByIndex

voidDeleteItemsByIndex (intseq items)


     
Parameters:
items
Returns:


GetRectangleOfMonitor

RectangleGetRectangleOfMonitor ()


     
Returns:


GetMinimumWidth

intGetMinimumWidth ()


     
Returns:


SetMinimumWidth

voidSetMinimumWidth (int value)


     
Parameters:
value
Returns:


GetWidth

intGetWidth ()


     
Returns:


SetWidth

voidSetWidth (int value)


     
Parameters:
value
Returns:


GetSelectedItemNameArray

stringseqGetSelectedItemNameArray ()


     
Returns:


SetSelectedItemNameArray

voidSetSelectedItemNameArray (stringseq values)


     
Parameters:
values
Returns:


GetMinimumHeight

intGetMinimumHeight ()


     
Returns:


SetMinimumHeight

voidSetMinimumHeight (int value)


     
Parameters:
value
Returns:


GetColumnHeaderText

StringGetColumnHeaderText ()


     
Returns:


SetColumnHeaderText

voidSetColumnHeaderText (String value)


     
Parameters:
value
Returns:


GetGroupItemNameArray

stringseqGetGroupItemNameArray ()


     
Returns:


SetGroupItemNameArray

voidSetGroupItemNameArray (stringseq values)


     
Parameters:
values
Returns:


GetMixedStateImage

StringGetMixedStateImage ()


     
Returns:


SetMixedStateImage

voidSetMixedStateImage (String value)


     
Parameters:
value
Returns:


GetGroupNameArray

stringseqGetGroupNameArray ()


     
Returns:


SetGroupNameArray

voidSetGroupNameArray (stringseq values)


     
Parameters:
values
Returns:


CanDrawContentDisabled

booleanCanDrawContentDisabled ()


     
Returns:


SetCanDrawContentDisabled

voidSetCanDrawContentDisabled (boolean flag)


     
Parameters:
flag
Returns:


GetDefaultHelpText

StringGetDefaultHelpText ()


     
Returns:


SetDefaultHelpText

voidSetDefaultHelpText (String value)


     
Parameters:
value
Returns:


GetHeight

intGetHeight ()


     
Returns:


SetHeight

voidSetHeight (int value)


     
Parameters:
value
Returns:


GetDragItemName

StringGetDragItemName ()


     
Returns:


GetOrientation

OrientationGetOrientation ()


     
Returns:


SetOrientation

voidSetOrientation (Orientation value)


     
Parameters:
value
Returns:


HasScrollBarsWhenNeeded

booleanHasScrollBarsWhenNeeded ()


     
Returns:


SetHasScrollBarsWhenNeeded

voidSetHasScrollBarsWhenNeeded (boolean flag)


     
Parameters:
flag
Returns:


GetDragCursorImage

StringGetDragCursorImage ()


     
Returns:


SetDragCursorImage

voidSetDragCursorImage (String value)


     
Parameters:
value
Returns:


GetGroupOpenArray

intseqGetGroupOpenArray ()


     
Returns:


SetGroupOpenArray

voidSetGroupOpenArray (intseq values)


     
Parameters:
values
Returns:


GetKeyPressed

KeyGetKeyPressed ()


     
Returns:


SetKeyPressed

voidSetKeyPressed (Key key)


     
Parameters:
key
Returns:


DoesSizeByContents

booleanDoesSizeByContents ()


     
Returns:


SetSizeByContents

voidSetSizeByContents (boolean flag)


     
Parameters:
flag
Returns:


GetDropGroupName

StringGetDropGroupName ()


     
Returns:


GetColumnHeaderTextAlignment

AlignmentGetColumnHeaderTextAlignment ()


     
Returns:


SetColumnHeaderTextAlignment

voidSetColumnHeaderTextAlignment (Alignment value)


     
Parameters:
value
Returns:


GetFocusGroupName

StringGetFocusGroupName ()


     
Returns:


SetFocusGroupName

voidSetFocusGroupName (String value)


     
Parameters:
value
Returns:


CanWrap

booleanCanWrap ()


     
Returns:


SetCanWrap

voidSetCanWrap (boolean flag)


     
Parameters:
flag
Returns:


GetListType

ListTypeGetListType ()


     
Returns:


SetListType

voidSetListType (ListType value)


     
Parameters:
value
Returns:


GetDragNotValidCursorImage

StringGetDragNotValidCursorImage ()


     
Returns:


SetDragNotValidCursorImage

voidSetDragNotValidCursorImage (String value)


     
Parameters:
value
Returns:


GetItemTextColorArray

ColorsGetItemTextColorArray ()


     
Returns:


SetItemTextColorArray

voidSetItemTextColorArray (Colors colors)


     
Parameters:
colors
Returns:


GetContentArrangement

intGetContentArrangement ()


     
Returns:


SetContentArrangement

voidSetContentArrangement (int value)


     
Parameters:
value
Returns:


GetVerticalCells

intGetVerticalCells ()


     
Returns:


SetVerticalCells

voidSetVerticalCells (int value)


     
Parameters:
value
Returns:


GetDropItemName

StringGetDropItemName ()


     
Returns:


GetItemImageArray

stringseqGetItemImageArray ()


     
Returns:


SetItemImageArray

voidSetItemImageArray (stringseq values)


     
Parameters:
values
Returns:


GetDefaultTabStop

intGetDefaultTabStop ()


     
Returns:


SetDefaultTabStop

voidSetDefaultTabStop (int value)


     
Parameters:
value
Returns:


GetItemCheckedStateArray

intseqGetItemCheckedStateArray ()


     
Returns:


SetItemCheckedStateArray

voidSetItemCheckedStateArray (intseq values)


     
Parameters:
values
Returns:


GetAlternateRowColor

ColorGetAlternateRowColor ()


     
Returns:


SetAlternateRowColor

voidSetAlternateRowColor (Color color)


     
Parameters:
color
Returns:


GetItemHelpTextArray

stringseqGetItemHelpTextArray ()


     
Returns:


SetItemHelpTextArray

voidSetItemHelpTextArray (stringseq values)


     
Parameters:
values
Returns:


IsValidDragSite

booleanIsValidDragSite ()


     
Returns:


SetValidDragSite

voidSetValidDragSite (boolean flag)


     
Parameters:
flag
Returns:


GetImageWidth

intGetImageWidth ()


     
Returns:


SetImageWidth

voidSetImageWidth (int value)


     
Parameters:
value
Returns:


GetItemBackgroundColorArray

ColorsGetItemBackgroundColorArray ()


     
Returns:


SetItemBackgroundColorArray

voidSetItemBackgroundColorArray (Colors colors)


     
Parameters:
colors
Returns:


GetScrollBarPosition

ScrollBarPositionGetScrollBarPosition ()


     
Returns:


SetScrollBarPosition

voidSetScrollBarPosition (ScrollBarPosition value)


     
Parameters:
value
Returns:


GetDragGroupName

StringGetDragGroupName ()


     
Returns:


SetDragGroupName

voidSetDragGroupName (String value)


     
Parameters:
value
Returns:


CanTruncateText

booleanCanTruncateText ()


     
Returns:


SetCanTruncateText

voidSetCanTruncateText (boolean flag)


     
Parameters:
flag
Returns:


DoesItemSelectOnRMB

booleanDoesItemSelectOnRMB ()


     
Returns:


SetItemSelectOnRMB

voidSetItemSelectOnRMB (boolean flag)


     
Parameters:
flag
Returns:


GetHorizontalCells

intGetHorizontalCells ()


     
Returns:


SetHorizontalCells

voidSetHorizontalCells (int value)


     
Parameters:
value
Returns:


GetMaximumWidth

intGetMaximumWidth ()


     
Returns:


SetMaximumWidth

voidSetMaximumWidth (int value)


     
Parameters:
value
Returns:


GetItemNameArray

stringseqGetItemNameArray ()


     
Returns:


SetItemNameArray

voidSetItemNameArray (stringseq values)


     
Parameters:
values
Returns:


GetItemSelectionDelay

intGetItemSelectionDelay ()


     
Returns:


SetItemSelectionDelay

voidSetItemSelectionDelay (int value)


     
Parameters:
value
Returns:


GetImageHeight

intGetImageHeight ()


     
Returns:


SetImageHeight

voidSetImageHeight (int value)


     
Parameters:
value
Returns:


IsSelectionVisible

booleanIsSelectionVisible ()


     
Returns:


SetSelectionVisible

voidSetSelectionVisible (boolean flag)


     
Parameters:
flag
Returns:


CanResizeWhenNeeded

booleanCanResizeWhenNeeded ()


     
Returns:


SetCanResizeWhenNeeded

voidSetCanResizeWhenNeeded (boolean flag)


     
Parameters:
flag
Returns:


GetUnsetStateImage

StringGetUnsetStateImage ()


     
Returns:


SetUnsetStateImage

voidSetUnsetStateImage (String value)


     
Parameters:
value
Returns:


GetEnabledItemNameArray

stringseqGetEnabledItemNameArray ()


     
Returns:


SetEnabledItemNameArray

voidSetEnabledItemNameArray (stringseq values)


     
Parameters:
values
Returns:


GetFocusItemName

StringGetFocusItemName ()


     
Returns:


SetFocusItemName

voidSetFocusItemName (String value)


     
Parameters:
value
Returns:


CanRedraw

booleanCanRedraw ()


     
Returns:


SetCanRedraw

voidSetCanRedraw (boolean flag)


     
Parameters:
flag
Returns:


GetMostRecentGroupName

StringGetMostRecentGroupName ()


     
Returns:


GetGroupHelpTextArray

stringseqGetGroupHelpTextArray ()


     
Returns:


SetGroupHelpTextArray

voidSetGroupHelpTextArray (stringseq values)


     
Parameters:
values
Returns:


GetMostRecentItemName

StringGetMostRecentItemName ()


     
Returns:


GetPrompt

StringGetPrompt ()


     
Returns:


SetPrompt

voidSetPrompt (String value)


     
Parameters:
value
Returns:


GetGroupTextArray

stringseqGetGroupTextArray ()


     
Returns:


SetGroupTextArray

voidSetGroupTextArray (stringseq values)


     
Parameters:
values
Returns:


GetTabStopArray

intseqGetTabStopArray ()


     
Returns:


SetTabStopArray

voidSetTabStopArray (intseq values)


     
Parameters:
values
Returns:


GetItemTextArray

stringseqGetItemTextArray ()


     
Returns:


SetItemTextArray

voidSetItemTextArray (stringseq values)


     
Parameters:
values
Returns:


GetSetStateImage

StringGetSetStateImage ()


     
Returns:


SetSetStateImage

voidSetSetStateImage (String value)


     
Parameters:
value
Returns:


GetItemSelectionPolicy

SelectionPolicyGetItemSelectionPolicy ()


     
Returns:


SetItemSelectionPolicy

voidSetItemSelectionPolicy (SelectionPolicy value)


     
Parameters:
value
Returns:


GetDefaultColumnWidth

intGetDefaultColumnWidth ()


     
Returns:


SetDefaultColumnWidth

voidSetDefaultColumnWidth (int value)


     
Parameters:
value
Returns:


OnlyScrollItemNameIntoView

StringOnlyScrollItemNameIntoView ()


     
Returns:


ScrollItemNameIntoView

voidScrollItemNameIntoView (String value)


     
Parameters:
value
Returns:


DoesScrollOnKeyboardInput

booleanDoesScrollOnKeyboardInput ()


     
Returns:


SetScrollOnKeyboardInput

voidSetScrollOnKeyboardInput (boolean flag)


     
Parameters:
flag
Returns:


GetGroupImageArray

stringseqGetGroupImageArray ()


     
Returns:


SetGroupImageArray

voidSetGroupImageArray (stringseq values)


     
Parameters:
values
Returns:


HasBorder

booleanHasBorder ()


     
Returns:


SetHasBorder

voidSetHasBorder (boolean flag)


     
Parameters:
flag
Returns:


GetSelectedItemIndex

intGetSelectedItemIndex ()


     
Returns:


SetSelectedItemIndex

voidSetSelectedItemIndex (int value)


     
Parameters:
value
Returns:


GetSelectedItemName

StringGetSelectedItemName ()


     
Returns:


SetSelectedItemName

voidSetSelectedItemName (String value)


     
Parameters:
value
Returns:


AddActionListener

voidAddActionListener (ListListener listener)


     
Parameters:
listener
Returns:


PushAction

voidPushAction (ListAction action)


     
Parameters:
action
Returns:


CreateTimer

voidCreateTimer (ListTimer timer, String timerName, boolean writeInTrail)


     
Parameters:
timer
timerName
writeInTrail
Returns:


StartTimer

voidStartTimer (String timerName, int duration)


     
Parameters:
timerName
duration
Returns:


StopTimer

voidStopTimer (String timerName)


     
Parameters:
timerName
Returns: