CIP JAVA documentation for class "com.ptc.uifc.uifcDialog.Dialog"

Interface Dialog

package com.ptc.uifc.uifcDialog; public interface Dialog extends com.ptc.uifc.uifcGridContainer.GridContainer

Description

Method Summary
`void`	`AddActionListener (DialogListener listener)`
`boolean`	`CanMakeFrontInBackground ()`
`boolean`	`CanNavigateIntoParent ()`
`boolean`	`CanTruncateTitleText ()`
`void`	`CreateTimer (DialogTimer timer, String timerName, boolean writeInTrail)`
`void`	`DeleteChild (String name)`
`void`	`DeletePopupMenu ()`
`boolean`	`DoesForceOnScreen ()`
`boolean`	`DoesMakeActiveOnDisplay ()`
`boolean`	`DoesMakeFrontOnActive ()`
`boolean`	`DoesRememberPosition ()`
`boolean`	`DoesSizeToFit ()`
`boolean`	`DoesTrackMoveSize ()`
`Key`	`GetAcceleratorKey ()`
`String`	`GetAcceleratorText ()`
`AnchorPosition`	`GetAnchorLocation ()`
`String`	`GetAppNameTag ()`
`int`	`GetBorderBottomSize ()`
`int`	`GetBorderLeftSize ()`
`int`	`GetBorderRightSize ()`
`int`	`GetBorderTopSize ()`
`String`	`GetDefaultButtonName ()`
`String`	`GetFocusComponentName ()`
`Dimension`	`GetFrameMinimumSize ()`
`Point`	`GetFrameOrigin ()`
`int`	`GetFrameOriginX ()`
`int`	`GetFrameOriginY ()`
`Rectangle`	`GetFrameRectangle ()`
`Dimension`	`GetFrameSize ()`
`int`	`GetFrameSizeHeight ()`
`int`	`GetFrameSizeWidth ()`
`String`	`GetInFrontOfDialogName ()`
`DialogStyle`	`GetModality ()`
`String`	`GetOwnerName ()`
`String`	`GetPaletteName ()`
`Rectangle`	`GetRectangleOfMonitor ()`
`int`	`GetScreenBottomOffset ()`
`int`	`GetScreenLeftOffset ()`
`Point`	`GetScreenOrigin ()`
`Rectangle`	`GetScreenRectangle ()`
`int`	`GetScreenRightOffset ()`
`int`	`GetScreenTopOffset ()`
`StartLocation`	`GetStartLocation ()`
`String`	`GetTitleImage ()`
`LabelAlignment`	`GetTitleTextAlignment ()`
`boolean`	`HasCloseButton ()`
`boolean`	`HasDropShadow ()`
`boolean`	`HasHelpButton ()`
`boolean`	`HasMaximizeButton ()`
`boolean`	`HasMinimizeButton ()`
`boolean`	`HasSizeBox ()`
`boolean`	`HasSystemMenuButton ()`
`int`	`InsertChild (Component component, GridData gridData)`
`int`	`InsertPopupMenu (Component component)`
`boolean`	`IsMaximized ()`
`boolean`	`IsMinimized ()`
`boolean`	`IsResizable ()`
`boolean`	`IsTitleBarVisible ()`
`void`	`MakeActive ()`
`void`	`MakeForeground ()`
`void`	`MakeFront ()`
`void`	`MinimizePopup ()`
`void`	`PushAction (DialogAction action)`
`void`	`ResetFrameSize ()`
`void`	`RestorePopup ()`
`void`	`SetAcceleratorKey (Key key)`
`void`	`SetAnchorLocation (AnchorPosition value)`
`void`	`SetAppNameTag (String value)`
`void`	`SetBorderBottomSize (int value)`
`void`	`SetBorderLeftSize (int value)`
`void`	`SetBorderRightSize (int value)`
`void`	`SetBorderTopSize (int value)`
`void`	`SetCanMakeFrontInBackground (boolean flag)`
`void`	`SetCanNavigateIntoParent (boolean flag)`
`void`	`SetCanTruncateTitleText (boolean flag)`
`void`	`SetDefaultButtonName (String value)`
`void`	`SetFocusComponentName (String value)`
`void`	`SetForceOnScreen (boolean flag)`
`void`	`SetFrameOrigin (Point value)`
`void`	`SetFrameOriginX (int value)`
`void`	`SetFrameOriginY (int value)`
`void`	`SetFrameRectangle (Rectangle rect)`
`void`	`SetFrameSize (Dimension value)`
`void`	`SetFrameSizeHeight (int value)`
`void`	`SetFrameSizeWidth (int value)`
`void`	`SetHasCloseButton (boolean flag)`
`void`	`SetHasDropShadow (boolean flag)`
`void`	`SetHasHelpButton (boolean flag)`
`void`	`SetHasMaximizeButton (boolean flag)`
`void`	`SetHasMinimizeButton (boolean flag)`
`void`	`SetHasSizeBox (boolean flag)`
`void`	`SetHasSystemMenuButton (boolean flag)`
`void`	`SetInFrontOfDialogName (String value)`
`void`	`SetMakeActiveOnDisplay (boolean flag)`
`void`	`SetMakeFrontOnActive (boolean flag)`
`void`	`SetMaximized (boolean flag)`
`void`	`SetMinimized (boolean flag)`
`void`	`SetModality (DialogStyle value)`
`void`	`SetOwnerName (String value)`
`void`	`SetPaletteName (String value)`
`void`	`SetRememberPosition (boolean flag)`
`void`	`SetResizable (boolean flag)`
`void`	`SetScreenBottomOffset (int value)`
`void`	`SetScreenLeftOffset (int value)`
`void`	`SetScreenRightOffset (int value)`
`void`	`SetScreenTopOffset (int value)`
`void`	`SetSizeToFit (boolean flag)`
`void`	`SetStartLocation (StartLocation value)`
`void`	`SetTitleBarVisible (boolean flag)`
`void`	`SetTitleImage (String value)`
`void`	`SetTitleTextAlignment (LabelAlignment value)`
`void`	`SetTrackMoveSize (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.uifcGridContainer.GridContainer`
`GetMinimumWidth`, `SetMinimumWidth`, `GetMinimumHeight`, `SetMinimumHeight`, `GetTitleImage`, `SetTitleImage`, `DoesRememberSize`, `SetRememberSize`, `GetTitleText`, `SetTitleText`, `GetHeight`, `SetHeight`, `GetWidth`, `SetWidth`, `HasBorder`, `SetHasBorder`

Method Detail

MinimizePopup

void MinimizePopup ()

Returns:

DeletePopupMenu

void DeletePopupMenu ()

Returns:

GetFrameOrigin

Point GetFrameOrigin ()

Returns:

InsertPopupMenu

int InsertPopupMenu (Component component)

Parameters:

component

Returns:

SetFrameOrigin

void SetFrameOrigin (Point value)

Parameters:

value

Returns:

MakeForeground

void MakeForeground ()

Returns:

InsertChild

int InsertChild (Component component, GridData gridData)

Parameters:

component
gridData

Returns:

GetFrameMinimumSize

Dimension GetFrameMinimumSize ()

Returns:

ResetFrameSize

void ResetFrameSize ()

Returns:

SetFrameSize

void SetFrameSize (Dimension value)

Parameters:

value

Returns:

GetScreenRectangle

Rectangle GetScreenRectangle ()

Returns:

GetRectangleOfMonitor

Rectangle GetRectangleOfMonitor ()

Returns:

GetScreenOrigin

Point GetScreenOrigin ()

Returns:

MakeActive

void MakeActive ()

Returns:

MakeFront

void MakeFront ()

Returns:

SetFrameRectangle

void SetFrameRectangle (Rectangle rect)

Parameters:

rect

Returns:

RestorePopup

void RestorePopup ()

Returns:

DeleteChild

void DeleteChild (String name)

Parameters:

name

Returns:

GetFrameSize

Dimension GetFrameSize ()

Returns:

GetFrameRectangle

Rectangle GetFrameRectangle ()

Returns:

GetBorderBottomSize

int GetBorderBottomSize ()

Returns:

SetBorderBottomSize

void SetBorderBottomSize (int value)

Parameters:

value

Returns:

DoesMakeActiveOnDisplay

boolean DoesMakeActiveOnDisplay ()

Returns:

SetMakeActiveOnDisplay

void SetMakeActiveOnDisplay (boolean flag)

Parameters:

flag

Returns:

DoesTrackMoveSize

boolean DoesTrackMoveSize ()

Returns:

SetTrackMoveSize

void SetTrackMoveSize (boolean flag)

Parameters:

flag

Returns:

GetFocusComponentName

String GetFocusComponentName ()

Returns:

SetFocusComponentName

void SetFocusComponentName (String value)

Parameters:

value

Returns:

GetScreenTopOffset

int GetScreenTopOffset ()

Returns:

SetScreenTopOffset

void SetScreenTopOffset (int value)

Parameters:

value

Returns:

GetFrameSizeWidth

int GetFrameSizeWidth ()

Returns:

SetFrameSizeWidth

void SetFrameSizeWidth (int value)

Parameters:

value

Returns:

HasDropShadow

boolean HasDropShadow ()

Returns:

SetHasDropShadow

void SetHasDropShadow (boolean flag)

Parameters:

flag

Returns:

GetBorderLeftSize

int GetBorderLeftSize ()

Returns:

SetBorderLeftSize

void SetBorderLeftSize (int value)

Parameters:

value

Returns:

CanNavigateIntoParent

boolean CanNavigateIntoParent ()

Returns:

SetCanNavigateIntoParent

void SetCanNavigateIntoParent (boolean flag)

Parameters:

flag

Returns:

GetFrameSizeHeight

int GetFrameSizeHeight ()

Returns:

SetFrameSizeHeight

void SetFrameSizeHeight (int value)

Parameters:

value

Returns:

HasSizeBox

boolean HasSizeBox ()

Returns:

SetHasSizeBox

void SetHasSizeBox (boolean flag)

Parameters:

flag

Returns:

IsTitleBarVisible

boolean IsTitleBarVisible ()

Returns:

SetTitleBarVisible

void SetTitleBarVisible (boolean flag)

Parameters:

flag

Returns:

GetDefaultButtonName

String GetDefaultButtonName ()

Returns:

SetDefaultButtonName

void SetDefaultButtonName (String value)

Parameters:

value

Returns:

DoesRememberPosition

boolean DoesRememberPosition ()

Returns:

SetRememberPosition

void SetRememberPosition (boolean flag)

Parameters:

flag

Returns:

GetAcceleratorKey

Key GetAcceleratorKey ()

Returns:

SetAcceleratorKey

void SetAcceleratorKey (Key key)

Parameters:

key

Returns:

GetInFrontOfDialogName

String GetInFrontOfDialogName ()

Returns:

SetInFrontOfDialogName

void SetInFrontOfDialogName (String value)

Parameters:

value

Returns:

HasSystemMenuButton

boolean HasSystemMenuButton ()

Returns:

SetHasSystemMenuButton

void SetHasSystemMenuButton (boolean flag)

Parameters:

flag

Returns:

HasHelpButton

boolean HasHelpButton ()

Returns:

SetHasHelpButton

void SetHasHelpButton (boolean flag)

Parameters:

flag

Returns:

DoesMakeFrontOnActive

boolean DoesMakeFrontOnActive ()

Returns:

SetMakeFrontOnActive

void SetMakeFrontOnActive (boolean flag)

Parameters:

flag

Returns:

GetFrameOriginX

int GetFrameOriginX ()

Returns:

SetFrameOriginX

void SetFrameOriginX (int value)

Parameters:

value

Returns:

GetTitleImage

String GetTitleImage ()

Returns:

SetTitleImage

void SetTitleImage (String value)

Parameters:

value

Returns:

GetAppNameTag

String GetAppNameTag ()

Returns:

SetAppNameTag

void SetAppNameTag (String value)

Parameters:

value

Returns:

IsMaximized

boolean IsMaximized ()

Returns:

SetMaximized

void SetMaximized (boolean flag)

Parameters:

flag

Returns:

GetTitleTextAlignment

LabelAlignment GetTitleTextAlignment ()

Returns:

SetTitleTextAlignment

void SetTitleTextAlignment (LabelAlignment value)

Parameters:

value

Returns:

HasCloseButton

boolean HasCloseButton ()

Returns:

SetHasCloseButton

void SetHasCloseButton (boolean flag)

Parameters:

flag

Returns:

CanTruncateTitleText

boolean CanTruncateTitleText ()

Returns:

SetCanTruncateTitleText

void SetCanTruncateTitleText (boolean flag)

Parameters:

flag

Returns:

GetPaletteName

String GetPaletteName ()

Returns:

SetPaletteName

void SetPaletteName (String value)

Parameters:

value

Returns:

GetOwnerName

String GetOwnerName ()

Returns:

SetOwnerName

void SetOwnerName (String value)

Parameters:

value

Returns:

DoesForceOnScreen

boolean DoesForceOnScreen ()

Returns:

SetForceOnScreen

void SetForceOnScreen (boolean flag)

Parameters:

flag

Returns:

CanMakeFrontInBackground

boolean CanMakeFrontInBackground ()

Returns:

SetCanMakeFrontInBackground

void SetCanMakeFrontInBackground (boolean flag)

Parameters:

flag

Returns:

GetBorderRightSize

int GetBorderRightSize ()

Returns:

SetBorderRightSize

void SetBorderRightSize (int value)

Parameters:

value

Returns:

IsMinimized

boolean IsMinimized ()

Returns:

SetMinimized

void SetMinimized (boolean flag)

Parameters:

flag

Returns:

IsResizable

boolean IsResizable ()

Returns:

SetResizable

void SetResizable (boolean flag)

Parameters:

flag

Returns:

HasMaximizeButton

boolean HasMaximizeButton ()

Returns:

SetHasMaximizeButton

void SetHasMaximizeButton (boolean flag)

Parameters:

flag

Returns:

GetScreenLeftOffset

int GetScreenLeftOffset ()

Returns:

SetScreenLeftOffset

void SetScreenLeftOffset (int value)

Parameters:

value

Returns:

GetModality

DialogStyle GetModality ()

Returns:

SetModality

void SetModality (DialogStyle value)

Parameters:

value

Returns:

GetFrameOriginY

int GetFrameOriginY ()

Returns:

SetFrameOriginY

void SetFrameOriginY (int value)

Parameters:

value

Returns:

DoesSizeToFit

boolean DoesSizeToFit ()

Returns:

SetSizeToFit

void SetSizeToFit (boolean flag)

Parameters:

flag

Returns:

GetBorderTopSize

int GetBorderTopSize ()

Returns:

SetBorderTopSize

void SetBorderTopSize (int value)

Parameters:

value

Returns:

HasMinimizeButton

boolean HasMinimizeButton ()

Returns:

SetHasMinimizeButton

void SetHasMinimizeButton (boolean flag)

Parameters:

flag

Returns:

GetAnchorLocation

AnchorPosition GetAnchorLocation ()

Returns:

SetAnchorLocation

void SetAnchorLocation (AnchorPosition value)

Parameters:

value

Returns:

GetStartLocation

StartLocation GetStartLocation ()

Returns:

SetStartLocation

void SetStartLocation (StartLocation value)

Parameters:

value

Returns:

GetScreenRightOffset

int GetScreenRightOffset ()

Returns:

SetScreenRightOffset

void SetScreenRightOffset (int value)

Parameters:

value

Returns:

GetAcceleratorText

String GetAcceleratorText ()

Returns:

GetScreenBottomOffset

int GetScreenBottomOffset ()

Returns:

SetScreenBottomOffset

void SetScreenBottomOffset (int value)

Parameters:

value

Returns:

AddActionListener

void AddActionListener (DialogListener listener)

Parameters:

listener

Returns:

PushAction

void PushAction (DialogAction action)

Parameters:

action

Returns:

CreateTimer

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