Library | Package Java Toolkit

Interface OptionMenu

package com.ptc.uifc.uifcOptionMenu;

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



Description

 



Method Summary
voidAddActionListener (OptionMenuListener listener)
     
booleanCanDrawContentDisabled ()
     
booleanCanRedraw ()
     
booleanCanResizeWhenNeeded ()
     
booleanCanTruncateText ()
     
voidCopySelectionToClipboard ()
     
voidCreateTimer (OptionMenuTimer timer, String timerName, boolean writeInTrail)
     
voidCutSelectionToClipboard ()
     
voidDeleteGroupsByName (stringseq names)
     
voidDeleteItemsByIndex (intseq items)
     
voidDeleteItemsByName (stringseq names)
     
voidDeletePopupMenu ()
     
booleanDoesAlwaysShowValueSign ()
     
booleanDoesAutoCompleteReplace ()
     
booleanDoesAutoOpen ()
     
booleanDoesOpenOnMnemonic ()
     
booleanDoesSizeByContents ()
     
intGetAutoCompleteLength ()
     
intGetCaretPosition ()
     
StringGetDefaultHelpText ()
     
intGetDigits ()
     
StringGetDoubleFormat ()
     
doubleGetDoubleValue ()
     
realseqGetDoubleValueArray ()
     
intGetDropDownHeight ()
     
StringGetDropItemName ()
     
stringseqGetEnabledItemNameArray ()
     
DimensionGetFrameMinimumSize ()
     
PointGetFrameOrigin ()
     
RectangleGetFrameRectangle ()
     
DimensionGetFrameSize ()
     
stringseqGetGroupHelpTextArray ()
     
stringseqGetGroupImageArray ()
     
stringseqGetGroupItemNameArray ()
     
stringseqGetGroupNameArray ()
     
intseqGetGroupOpenArray ()
     
stringseqGetGroupTextArray ()
     
StringGetImage ()
     
intGetImageHeight ()
     
intGetImageWidth ()
     
intGetIntegerValue ()
     
intseqGetIntegerValueArray ()
     
ColorsGetItemBackgroundColorArray ()
     
stringseqGetItemHelpTextArray ()
     
stringseqGetItemImageArray ()
     
stringseqGetItemNameArray ()
     
stringseqGetItemTextArray ()
     
ColorsGetItemTextColorArray ()
     
intGetLineLength (int line)
     
doubleGetMaximumDoubleValue ()
     
intGetMaximumIntegerValue ()
     
intGetMaximumWidth ()
     
doubleGetMinimumDoubleValue ()
     
intGetMinimumIntegerValue ()
     
intGetMinimumWidth ()
     
StringGetMostRecentItemName ()
     
StringGetPrompt ()
     
ReadingOrderGetReadingOrder ()
     
RectangleGetRectangleOfMonitor ()
     
PointGetScreenOrigin ()
     
RectangleGetScreenRectangle ()
     
stringseqGetSelectedItemNameArray ()
     
PointGetSelectedRange ()
     
StringGetSelectedText ()
     
StringGetStringValue ()
     
stringseqGetStringValueArray ()
     
intGetTextGravity ()
     
StringGetTextValue ()
     
intGetTextValueMaximumLength ()
     
InputTypeGetValueType ()
     
intGetWidth ()
     
booleanHasBorder ()
     
booleanHasTextChanged ()
     
voidInputBackspaceKeys (int count)
     
voidInputDeleteKeys (int count)
     
voidInsertGroup (OptionMenuGroup optionmenugroup, ItemPositionData item_pos_data)
     
voidInsertItem (OptionMenuItem optionmenuitem, ItemPositionData item_pos_data)
     
voidInsertItems (OptionMenuItems optionmenuitems, ItemPositionData posData)
     
intInsertPopupMenu (Component component)
     
voidInsertTextIntoSelection (String text)
     
booleanIsAutoCompleteCaseSensitive ()
     
booleanIsCaretVisible ()
     
booleanIsComboBox ()
     
booleanIsSelectionVisible ()
     
booleanIsWidthFixed ()
     
voidMoveItemsByIndex (int item, intseq items)
     
voidMoveItemsByName (String name, stringseq names)
     
voidOpenPopup ()
     
voidPasteClipboardToSelection ()
     
voidPushAction (OptionMenuAction action)
     
voidRedoLastUndo ()
     
voidReplaceSelectionWithText (int start, int end, String text)
     
voidSelectAll ()
     
voidSetAlwaysShowValueSign (boolean flag)
     
voidSetAutoCompleteCaseSensitive (boolean flag)
     
voidSetAutoCompleteLength (int value)
     
voidSetAutoCompleteReplace (boolean flag)
     
voidSetAutoOpen (boolean flag)
     
voidSetCanDrawContentDisabled (boolean flag)
     
voidSetCanRedraw (boolean flag)
     
voidSetCanResizeWhenNeeded (boolean flag)
     
voidSetCanTruncateText (boolean flag)
     
voidSetCaretPosition (int position)
     
voidSetCaretVisible (boolean flag)
     
voidSetComboBox (boolean flag)
     
voidSetDefaultHelpText (String value)
     
voidSetDigits (int value)
     
voidSetDoubleFormat (String value)
     
voidSetDoubleValue (double value)
     
voidSetDoubleValueArray (realseq values)
     
voidSetDropDownHeight (int value)
     
voidSetEnabledItemNameArray (stringseq values)
     
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)
     
voidSetHasTextChanged (boolean flag)
     
voidSetImage (String value)
     
voidSetImageHeight (int value)
     
voidSetImageWidth (int value)
     
voidSetIntegerValue (int value)
     
voidSetIntegerValueArray (intseq values)
     
voidSetItemBackgroundColorArray (Colors colors)
     
voidSetItemHelpTextArray (stringseq values)
     
voidSetItemImageArray (stringseq values)
     
voidSetItemNameArray (stringseq values)
     
voidSetItemTextArray (stringseq values)
     
voidSetItemTextColorArray (Colors colors)
     
voidSetMaximumDoubleValue (double value)
     
voidSetMaximumIntegerValue (int value)
     
voidSetMaximumWidth (int value)
     
voidSetMinimumDoubleValue (double value)
     
voidSetMinimumIntegerValue (int value)
     
voidSetMinimumWidth (int value)
     
voidSetOpenOnMnemonic (boolean flag)
     
voidSetPrompt (String value)
     
voidSetReadingOrder (ReadingOrder value)
     
voidSetSelectedItemNameArray (stringseq values)
     
voidSetSelectedRange (Point value)
     
voidSetSelectionVisible (boolean flag)
     
voidSetSizeByContents (boolean flag)
     
voidSetStringValue (String value)
     
voidSetStringValueArray (stringseq values)
     
voidSetTextGravity (int value)
     
voidSetTextValue (String value)
     
voidSetTextValueMaximumLength (int value)
     
voidSetValueType (InputType value)
     
voidSetWidth (int value)
     
voidSetWidthFixed (boolean flag)
     
voidStartTimer (String timerName, int duration)
     
voidStopTimer (String timerName)
     
voidUndoLastChange ()
     

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

InsertItem

voidInsertItem (OptionMenuItem optionmenuitem, ItemPositionData item_pos_data)


     
Parameters:
optionmenuitem
item_pos_data
Returns:


GetFrameOrigin

PointGetFrameOrigin ()


     
Returns:


DeleteGroupsByName

voidDeleteGroupsByName (stringseq names)


     
Parameters:
names
Returns:


GetCaretPosition

intGetCaretPosition ()


     
Returns:


OpenPopup

voidOpenPopup ()


     
Returns:


InputBackspaceKeys

voidInputBackspaceKeys (int count)


     
Parameters:
count
Returns:


ReplaceSelectionWithText

voidReplaceSelectionWithText (int start, int end, String text)


     
Parameters:
start
end
text
Returns:


InsertTextIntoSelection

voidInsertTextIntoSelection (String text)


     
Parameters:
text
Returns:


GetLineLength

intGetLineLength (int line)


     
Parameters:
line
Returns:


MoveItemsByName

voidMoveItemsByName (String name, stringseq names)


     
Parameters:
name
names
Returns:


SelectAll

voidSelectAll ()


     
Returns:


InsertPopupMenu

intInsertPopupMenu (Component component)


     
Parameters:
component
Returns:


UndoLastChange

voidUndoLastChange ()


     
Returns:


InsertGroup

voidInsertGroup (OptionMenuGroup optionmenugroup, ItemPositionData item_pos_data)


     
Parameters:
optionmenugroup
item_pos_data
Returns:


MoveItemsByIndex

voidMoveItemsByIndex (int item, intseq items)


     
Parameters:
item
items
Returns:


SetSelectedRange

voidSetSelectedRange (Point value)


     
Parameters:
value
Returns:


PasteClipboardToSelection

voidPasteClipboardToSelection ()


     
Returns:


GetFrameSize

DimensionGetFrameSize ()


     
Returns:


DeletePopupMenu

voidDeletePopupMenu ()


     
Returns:


GetScreenOrigin

PointGetScreenOrigin ()


     
Returns:


SetFrameOrigin

voidSetFrameOrigin (Point value)


     
Parameters:
value
Returns:


CopySelectionToClipboard

voidCopySelectionToClipboard ()


     
Returns:


CutSelectionToClipboard

voidCutSelectionToClipboard ()


     
Returns:


SetFrameSize

voidSetFrameSize (Dimension value)


     
Parameters:
value
Returns:


InputDeleteKeys

voidInputDeleteKeys (int count)


     
Parameters:
count
Returns:


SetCaretPosition

voidSetCaretPosition (int position)


     
Parameters:
position
Returns:


InsertItems

voidInsertItems (OptionMenuItems optionmenuitems, ItemPositionData posData)


     
Parameters:
optionmenuitems
posData
Returns:


GetFrameRectangle

RectangleGetFrameRectangle ()


     
Returns:


DeleteItemsByName

voidDeleteItemsByName (stringseq names)


     
Parameters:
names
Returns:


DeleteItemsByIndex

voidDeleteItemsByIndex (intseq items)


     
Parameters:
items
Returns:


GetSelectedRange

PointGetSelectedRange ()


     
Returns:


GetFrameMinimumSize

DimensionGetFrameMinimumSize ()


     
Returns:


GetScreenRectangle

RectangleGetScreenRectangle ()


     
Returns:


SetFrameRectangle

voidSetFrameRectangle (Rectangle rect)


     
Parameters:
rect
Returns:


RedoLastUndo

voidRedoLastUndo ()


     
Returns:


GetSelectedText

StringGetSelectedText ()


     
Returns:


GetRectangleOfMonitor

RectangleGetRectangleOfMonitor ()


     
Returns:


GetMaximumDoubleValue

doubleGetMaximumDoubleValue ()


     
Returns:


SetMaximumDoubleValue

voidSetMaximumDoubleValue (double value)


     
Parameters:
value
Returns:


GetWidth

intGetWidth ()


     
Returns:


SetWidth

voidSetWidth (int value)


     
Parameters:
value
Returns:


GetSelectedItemNameArray

stringseqGetSelectedItemNameArray ()


     
Returns:


SetSelectedItemNameArray

voidSetSelectedItemNameArray (stringseq values)


     
Parameters:
values
Returns:


GetMinimumWidth

intGetMinimumWidth ()


     
Returns:


SetMinimumWidth

voidSetMinimumWidth (int value)


     
Parameters:
value
Returns:


GetDoubleValue

doubleGetDoubleValue ()


     
Returns:


SetDoubleValue

voidSetDoubleValue (double value)


     
Parameters:
value
Returns:


GetGroupItemNameArray

stringseqGetGroupItemNameArray ()


     
Returns:


SetGroupItemNameArray

voidSetGroupItemNameArray (stringseq values)


     
Parameters:
values
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:


IsComboBox

booleanIsComboBox ()


     
Returns:


SetComboBox

voidSetComboBox (boolean flag)


     
Parameters:
flag
Returns:


GetDropDownHeight

intGetDropDownHeight ()


     
Returns:


SetDropDownHeight

voidSetDropDownHeight (int value)


     
Parameters:
value
Returns:


HasTextChanged

booleanHasTextChanged ()


     
Returns:


SetHasTextChanged

voidSetHasTextChanged (boolean flag)


     
Parameters:
flag
Returns:


GetStringValue

StringGetStringValue ()


     
Returns:


SetStringValue

voidSetStringValue (String value)


     
Parameters:
value
Returns:


GetGroupOpenArray

intseqGetGroupOpenArray ()


     
Returns:


SetGroupOpenArray

voidSetGroupOpenArray (intseq values)


     
Parameters:
values
Returns:


GetImage

StringGetImage ()


     
Returns:


SetImage

voidSetImage (String value)


     
Parameters:
value
Returns:


GetMaximumIntegerValue

intGetMaximumIntegerValue ()


     
Returns:


SetMaximumIntegerValue

voidSetMaximumIntegerValue (int value)


     
Parameters:
value
Returns:


DoesSizeByContents

booleanDoesSizeByContents ()


     
Returns:


SetSizeByContents

voidSetSizeByContents (boolean flag)


     
Parameters:
flag
Returns:


IsWidthFixed

booleanIsWidthFixed ()


     
Returns:


SetWidthFixed

voidSetWidthFixed (boolean flag)


     
Parameters:
flag
Returns:


GetStringValueArray

stringseqGetStringValueArray ()


     
Returns:


SetStringValueArray

voidSetStringValueArray (stringseq values)


     
Parameters:
values
Returns:


GetDoubleValueArray

realseqGetDoubleValueArray ()


     
Returns:


SetDoubleValueArray

voidSetDoubleValueArray (realseq values)


     
Parameters:
values
Returns:


GetIntegerValue

intGetIntegerValue ()


     
Returns:


SetIntegerValue

voidSetIntegerValue (int value)


     
Parameters:
value
Returns:


GetItemTextColorArray

ColorsGetItemTextColorArray ()


     
Returns:


SetItemTextColorArray

voidSetItemTextColorArray (Colors colors)


     
Parameters:
colors
Returns:


GetMinimumIntegerValue

intGetMinimumIntegerValue ()


     
Returns:


SetMinimumIntegerValue

voidSetMinimumIntegerValue (int value)


     
Parameters:
value
Returns:


GetDropItemName

StringGetDropItemName ()


     
Returns:


GetItemImageArray

stringseqGetItemImageArray ()


     
Returns:


SetItemImageArray

voidSetItemImageArray (stringseq values)


     
Parameters:
values
Returns:


GetValueType

InputTypeGetValueType ()


     
Returns:


SetValueType

voidSetValueType (InputType value)


     
Parameters:
value
Returns:


GetReadingOrder

ReadingOrderGetReadingOrder ()


     
Returns:


SetReadingOrder

voidSetReadingOrder (ReadingOrder value)


     
Parameters:
value
Returns:


DoesAlwaysShowValueSign

booleanDoesAlwaysShowValueSign ()


     
Returns:


SetAlwaysShowValueSign

voidSetAlwaysShowValueSign (boolean flag)


     
Parameters:
flag
Returns:


GetItemHelpTextArray

stringseqGetItemHelpTextArray ()


     
Returns:


SetItemHelpTextArray

voidSetItemHelpTextArray (stringseq values)


     
Parameters:
values
Returns:


GetAutoCompleteLength

intGetAutoCompleteLength ()


     
Returns:


SetAutoCompleteLength

voidSetAutoCompleteLength (int value)


     
Parameters:
value
Returns:


GetDigits

intGetDigits ()


     
Returns:


SetDigits

voidSetDigits (int value)


     
Parameters:
value
Returns:


GetDoubleFormat

StringGetDoubleFormat ()


     
Returns:


SetDoubleFormat

voidSetDoubleFormat (String value)


     
Parameters:
value
Returns:


GetImageWidth

intGetImageWidth ()


     
Returns:


SetImageWidth

voidSetImageWidth (int value)


     
Parameters:
value
Returns:


GetItemBackgroundColorArray

ColorsGetItemBackgroundColorArray ()


     
Returns:


SetItemBackgroundColorArray

voidSetItemBackgroundColorArray (Colors colors)


     
Parameters:
colors
Returns:


IsCaretVisible

booleanIsCaretVisible ()


     
Returns:


SetCaretVisible

voidSetCaretVisible (boolean flag)


     
Parameters:
flag
Returns:


CanTruncateText

booleanCanTruncateText ()


     
Returns:


SetCanTruncateText

voidSetCanTruncateText (boolean flag)


     
Parameters:
flag
Returns:


DoesAutoOpen

booleanDoesAutoOpen ()


     
Returns:


SetAutoOpen

voidSetAutoOpen (boolean flag)


     
Parameters:
flag
Returns:


GetMaximumWidth

intGetMaximumWidth ()


     
Returns:


SetMaximumWidth

voidSetMaximumWidth (int value)


     
Parameters:
value
Returns:


GetItemNameArray

stringseqGetItemNameArray ()


     
Returns:


SetItemNameArray

voidSetItemNameArray (stringseq values)


     
Parameters:
values
Returns:


GetTextValueMaximumLength

intGetTextValueMaximumLength ()


     
Returns:


SetTextValueMaximumLength

voidSetTextValueMaximumLength (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:


GetEnabledItemNameArray

stringseqGetEnabledItemNameArray ()


     
Returns:


SetEnabledItemNameArray

voidSetEnabledItemNameArray (stringseq values)


     
Parameters:
values
Returns:


CanRedraw

booleanCanRedraw ()


     
Returns:


SetCanRedraw

voidSetCanRedraw (boolean flag)


     
Parameters:
flag
Returns:


GetGroupHelpTextArray

stringseqGetGroupHelpTextArray ()


     
Returns:


SetGroupHelpTextArray

voidSetGroupHelpTextArray (stringseq values)


     
Parameters:
values
Returns:


GetMostRecentItemName

StringGetMostRecentItemName ()


     
Returns:


DoesOpenOnMnemonic

booleanDoesOpenOnMnemonic ()


     
Returns:


SetOpenOnMnemonic

voidSetOpenOnMnemonic (boolean flag)


     
Parameters:
flag
Returns:


GetPrompt

StringGetPrompt ()


     
Returns:


SetPrompt

voidSetPrompt (String value)


     
Parameters:
value
Returns:


GetMinimumDoubleValue

doubleGetMinimumDoubleValue ()


     
Returns:


SetMinimumDoubleValue

voidSetMinimumDoubleValue (double value)


     
Parameters:
value
Returns:


GetGroupTextArray

stringseqGetGroupTextArray ()


     
Returns:


SetGroupTextArray

voidSetGroupTextArray (stringseq values)


     
Parameters:
values
Returns:


GetItemTextArray

stringseqGetItemTextArray ()


     
Returns:


SetItemTextArray

voidSetItemTextArray (stringseq values)


     
Parameters:
values
Returns:


IsAutoCompleteCaseSensitive

booleanIsAutoCompleteCaseSensitive ()


     
Returns:


SetAutoCompleteCaseSensitive

voidSetAutoCompleteCaseSensitive (boolean flag)


     
Parameters:
flag
Returns:


GetTextGravity

intGetTextGravity ()


     
Returns:


SetTextGravity

voidSetTextGravity (int value)


     
Parameters:
value
Returns:


GetGroupImageArray

stringseqGetGroupImageArray ()


     
Returns:


SetGroupImageArray

voidSetGroupImageArray (stringseq values)


     
Parameters:
values
Returns:


HasBorder

booleanHasBorder ()


     
Returns:


SetHasBorder

voidSetHasBorder (boolean flag)


     
Parameters:
flag
Returns:


GetIntegerValueArray

intseqGetIntegerValueArray ()


     
Returns:


SetIntegerValueArray

voidSetIntegerValueArray (intseq values)


     
Parameters:
values
Returns:


DoesAutoCompleteReplace

booleanDoesAutoCompleteReplace ()


     
Returns:


SetAutoCompleteReplace

voidSetAutoCompleteReplace (boolean flag)


     
Parameters:
flag
Returns:


GetTextValue

StringGetTextValue ()


     
Returns:


SetTextValue

voidSetTextValue (String value)


     
Parameters:
value
Returns:


AddActionListener

voidAddActionListener (OptionMenuListener listener)


     
Parameters:
listener
Returns:


PushAction

voidPushAction (OptionMenuAction action)


     
Parameters:
action
Returns:


CreateTimer

voidCreateTimer (OptionMenuTimer 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: