CIP JAVA documentation for class "com.ptc.uifc.uifcCascadeButton.CascadeButton"

Interface CascadeButton

package com.ptc.uifc.uifcCascadeButton; public interface CascadeButton extends com.ptc.uifc.uifcButtonBase.ButtonBase

Description

Method Summary
`void`	`AddActionListener (CascadeButtonListener listener)`
`void`	`CreateTimer (CascadeButtonTimer timer, String timerName, boolean writeInTrail)`
`boolean`	`DoesAutoClose ()`
`boolean`	`DoesReplayDismissEvent ()`
`LabelAlignment`	`GetButtonPlacement ()`
`String`	`GetCascadeHelpText ()`
`CheckState`	`GetCheckedState ()`
`String`	`GetChildMenuName ()`
`String`	`GetDefaultHelpText ()`
`Dimension`	`GetFrameMinimumSize ()`
`Point`	`GetFrameOrigin ()`
`Rectangle`	`GetFrameRectangle ()`
`Dimension`	`GetFrameSize ()`
`Key`	`GetKeyPressed ()`
`Orientation`	`GetOrientation ()`
`Rectangle`	`GetRectangleOfMonitor ()`
`Point`	`GetScreenOrigin ()`
`Rectangle`	`GetScreenRectangle ()`
`Dimension`	`GetTextSize (String str)`
`int`	`IsMenuEnabled ()`
`boolean`	`IsSplitButton ()`
`boolean`	`IsSplitCheckButton ()`
`void`	`PushAction (CascadeButtonAction action)`
`void`	`SetAutoClose (boolean flag)`
`void`	`SetButtonPlacement (LabelAlignment value)`
`void`	`SetCascadeHelpText (String value)`
`void`	`SetCheckedState (CheckState value)`
`void`	`SetChildMenuName (String value)`
`void`	`SetDefaultHelpText (String value)`
`void`	`SetFrameOrigin (Point value)`
`void`	`SetFrameRectangle (Rectangle rect)`
`void`	`SetFrameSize (Dimension value)`
`void`	`SetKeyPressed (Key key)`
`void`	`SetMenuEnabled (int value)`
`void`	`SetOrientation (Orientation value)`
`void`	`SetReplayDismissEvent (boolean flag)`
`void`	`SetSplitButton (boolean flag)`
`void`	`SetSplitCheckButton (boolean flag)`
`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.uifcButtonBase.ButtonBase`
`GetImageColor`, `SetImageColor`, `GetAcceleratorKey`, `SetAcceleratorKey`, `GetDragCursorImage`, `SetDragCursorImage`, `GetImage`, `SetImage`, `GetTextAlignment`, `SetTextAlignment`, `GetButtonStyle`, `SetButtonStyle`, `CanWrap`, `SetCanWrap`, `GetTextFormat`, `SetTextFormat`, `GetDragNotValidCursorImage`, `SetDragNotValidCursorImage`, `GetContentArrangement`, `SetContentArrangement`, `DoesAllowKeyboardInput`, `SetAllowKeyboardInput`, `GetFontName`, `SetFontName`, `GetFontClass`, `SetFontClass`, `IsValidDragSite`, `SetValidDragSite`, `CanTruncateText`, `SetCanTruncateText`, `CanResizeWhenNeeded`, `SetCanResizeWhenNeeded`, `GetFontSize`, `SetFontSize`, `IsEnabled`, `SetEnabled`, `GetHelpText`, `SetHelpText`, `GetText`, `SetText`, `GetFontStyle`, `SetFontStyle`, `GetImageBackgroundColor`, `SetImageBackgroundColor`, `GetAcceleratorText`

Methods Inherited from Interface com.ptc.uifc.uifcButtonBase.ButtonBase

GetImageColor, SetImageColor, GetAcceleratorKey, SetAcceleratorKey, GetDragCursorImage, SetDragCursorImage, GetImage, SetImage, GetTextAlignment, SetTextAlignment, GetButtonStyle, SetButtonStyle, CanWrap, SetCanWrap, GetTextFormat, SetTextFormat, GetDragNotValidCursorImage, SetDragNotValidCursorImage, GetContentArrangement, SetContentArrangement, DoesAllowKeyboardInput, SetAllowKeyboardInput, GetFontName, SetFontName, GetFontClass, SetFontClass, IsValidDragSite, SetValidDragSite, CanTruncateText, SetCanTruncateText, CanResizeWhenNeeded, SetCanResizeWhenNeeded, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetText, SetText, GetFontStyle, SetFontStyle, GetImageBackgroundColor, SetImageBackgroundColor, GetAcceleratorText

Method Detail

SetFrameRectangle

void SetFrameRectangle (Rectangle rect)

Parameters:

rect

Returns:

GetFrameOrigin

Point GetFrameOrigin ()

Returns:

GetScreenOrigin

Point GetScreenOrigin ()

Returns:

SetFrameOrigin

void SetFrameOrigin (Point value)

Parameters:

value

Returns:

GetTextSize

Dimension GetTextSize (String str)

Parameters:

str

Returns:

GetFrameMinimumSize

Dimension GetFrameMinimumSize ()

Returns:

SetFrameSize

void SetFrameSize (Dimension value)

Parameters:

value

Returns:

GetScreenRectangle

Rectangle GetScreenRectangle ()

Returns:

GetRectangleOfMonitor

Rectangle GetRectangleOfMonitor ()

Returns:

GetFrameSize

Dimension GetFrameSize ()

Returns:

GetFrameRectangle

Rectangle GetFrameRectangle ()

Returns:

GetDefaultHelpText

String GetDefaultHelpText ()

Returns:

SetDefaultHelpText

void SetDefaultHelpText (String value)

Parameters:

value

Returns:

GetChildMenuName

String GetChildMenuName ()

Returns:

SetChildMenuName

void SetChildMenuName (String value)

Parameters:

value

Returns:

GetOrientation

Orientation GetOrientation ()

Returns:

SetOrientation

void SetOrientation (Orientation value)

Parameters:

value

Returns:

IsMenuEnabled

int IsMenuEnabled ()

Returns:

SetMenuEnabled

void SetMenuEnabled (int value)

Parameters:

value

Returns:

GetKeyPressed

Key GetKeyPressed ()

Returns:

SetKeyPressed

void SetKeyPressed (Key key)

Parameters:

key

Returns:

DoesReplayDismissEvent

boolean DoesReplayDismissEvent ()

Returns:

SetReplayDismissEvent

void SetReplayDismissEvent (boolean flag)

Parameters:

flag

Returns:

GetButtonPlacement

LabelAlignment GetButtonPlacement ()

Returns:

SetButtonPlacement

void SetButtonPlacement (LabelAlignment value)

Parameters:

value

Returns:

IsSplitButton

boolean IsSplitButton ()

Returns:

SetSplitButton

void SetSplitButton (boolean flag)

Parameters:

flag

Returns:

GetCascadeHelpText

String GetCascadeHelpText ()

Returns:

SetCascadeHelpText

void SetCascadeHelpText (String value)

Parameters:

value

Returns:

IsSplitCheckButton

boolean IsSplitCheckButton ()

Returns:

SetSplitCheckButton

void SetSplitCheckButton (boolean flag)

Parameters:

flag

Returns:

DoesAutoClose

boolean DoesAutoClose ()

Returns:

SetAutoClose

void SetAutoClose (boolean flag)

Parameters:

flag

Returns:

GetCheckedState

CheckState GetCheckedState ()

Returns:

SetCheckedState

void SetCheckedState (CheckState value)

Parameters:

value

Returns:

AddActionListener

void AddActionListener (CascadeButtonListener listener)

Parameters:

listener

Returns:

PushAction

void PushAction (CascadeButtonAction action)

Parameters:

action

Returns:

CreateTimer

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