CIP JAVA documentation for class "com.ptc.uifc.uifcDrawingArea.DrawingArea"

Interface DrawingArea

package com.ptc.uifc.uifcDrawingArea; public interface DrawingArea extends com.ptc.uifc.uifcComponent.Component

Description

Method Summary
`void`	`AddActionListener (DrawingAreaListener listener)`
`boolean`	`CanRedraw ()`
`void`	`Clear ()`
`void`	`CopyRectangle (Rectangle rect, Point point)`
`void`	`CreateTimer (DrawingAreaTimer timer, String timerName, boolean writeInTrail)`
`void`	`DeleteChild (String name)`
`void`	`DeletePopupMenu ()`
`boolean`	`DoesAllowKeyboardInput ()`
`boolean`	`DoesAllowWheelInput ()`
`boolean`	`DoesClipChildren ()`
`boolean`	`DoesTrackMouse ()`
`void`	`DrawArc (Arc arc)`
`void`	`DrawArcArray (Arcs arcs)`
`void`	`DrawEllipse (Rectangle rect)`
`void`	`DrawEllipseArray (Rectangles rects)`
`void`	`DrawImage (String image, Point position, ImageFlags flags)`
`void`	`DrawImages (stringseq images, Rectangles rects, Rectangles content_rects, ImageFlags flags)`
`void`	`DrawLine (Point start_point, Point end_point)`
`void`	`DrawLineArray (Points start_points, Points end_points)`
`void`	`DrawMultipleImages (stringseq images, Points points, ImageFlags flags)`
`void`	`DrawPoint (Point point)`
`void`	`DrawPointArray (Points points)`
`void`	`DrawPolygon (Points points)`
`void`	`DrawPolyline (Points points)`
`void`	`DrawRectangle (Rectangle rect)`
`void`	`DrawRectangleArray (Rectangles rects)`
`void`	`DrawText (String str, Point position)`
`void`	`DrawTextArray (stringseq strings, Points points)`
`void`	`FillArc (Arc arc)`
`void`	`FillArcArray (Arcs arcs)`
`void`	`FillEllipse (Rectangle rect)`
`void`	`FillEllipseArray (Rectangles rects)`
`void`	`FillGradientRectangle (Rectangle rect, Orientation orientation, Color color1, Color color2)`
`void`	`FillPolygon (Points points)`
`void`	`FillRectangle (Rectangle rect)`
`void`	`FillRectangleArray (Rectangles rects)`
`ArcDirection`	`GetArcDirection ()`
`ArcFillMode`	`GetArcFillMode ()`
`Point`	`GetCursorPosition ()`
`String`	`GetDragCursorImage ()`
`String`	`GetDragItemName ()`
`String`	`GetDragNotValidCursorImage ()`
`Color`	`GetDrawingBackgroundColor ()`
`Color`	`GetDrawingColor ()`
`stringseq`	`GetDrawingImageArray ()`
`DrawingMode`	`GetDrawingMode ()`
`FontClass`	`GetFontClass ()`
`String`	`GetFontName ()`
`double`	`GetFontSize ()`
`FontStyle`	`GetFontStyle ()`
`Dimension`	`GetFrameMinimumSize ()`
`Point`	`GetFrameOrigin ()`
`Rectangle`	`GetFrameRectangle ()`
`Dimension`	`GetFrameSize ()`
`int`	`GetHeight ()`
`String`	`GetHelpText ()`
`Dimension`	`GetImageSize (String image)`
`Key`	`GetKeyPressed ()`
`LineStyle`	`GetLineStyle ()`
`int`	`GetLineWidth ()`
`int`	`GetMinimumHeight ()`
`int`	`GetMinimumWidth ()`
`String`	`GetMostRecentItemName ()`
`PolygonFillMode`	`GetPolygonFillMode ()`
`Rectangle`	`GetRectangleOfMonitor ()`
`Point`	`GetScreenOrigin ()`
`Rectangle`	`GetScreenRectangle ()`
`int`	`GetTextBaseline (String str)`
`RichText`	`GetTextFormat ()`
`Dimension`	`GetTextSize (String str)`
`int`	`GetWidth ()`
`boolean`	`HasBorder ()`
`int`	`InsertChild (Component component)`
`int`	`InsertPopupMenu (Component component)`
`boolean`	`IsDoubleBuffered ()`
`boolean`	`IsEnabled ()`
`boolean`	`IsValidDragSite ()`
`void`	`PushAction (DrawingAreaAction action)`
`void`	`SetAllowKeyboardInput (boolean flag)`
`void`	`SetAllowWheelInput (boolean flag)`
`void`	`SetArcDirection (ArcDirection value)`
`void`	`SetArcFillMode (ArcFillMode value)`
`void`	`SetCanRedraw (boolean flag)`
`void`	`SetClipChildren (boolean flag)`
`void`	`SetDoubleBuffered (boolean flag)`
`void`	`SetDragCursorImage (String value)`
`void`	`SetDragItemName (String value)`
`void`	`SetDragNotValidCursorImage (String value)`
`void`	`SetDrawingBackgroundColor (Color color)`
`void`	`SetDrawingColor (Color color)`
`void`	`SetDrawingImageArray (stringseq values)`
`void`	`SetDrawingMode (DrawingMode value)`
`void`	`SetEnabled (boolean flag)`
`void`	`SetFontClass (FontClass value)`
`void`	`SetFontName (String value)`
`void`	`SetFontSize (double value)`
`void`	`SetFontStyle (FontStyle value)`
`void`	`SetFrameOrigin (Point value)`
`void`	`SetFrameRectangle (Rectangle rect)`
`void`	`SetFrameSize (Dimension value)`
`void`	`SetHasBorder (boolean flag)`
`void`	`SetHeight (int value)`
`void`	`SetHelpText (String value)`
`void`	`SetKeyPressed (Key key)`
`void`	`SetLineStyle (LineStyle value)`
`void`	`SetLineWidth (int value)`
`void`	`SetMinimumHeight (int value)`
`void`	`SetMinimumWidth (int value)`
`void`	`SetPolygonFillMode (PolygonFillMode value)`
`void`	`SetTextFormat (RichText value)`
`void`	`SetTrackMouse (boolean flag)`
`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

Method Detail

FillArc

void FillArc (Arc arc)

Parameters:

arc

Returns:

DrawEllipse

void DrawEllipse (Rectangle rect)

Parameters:

rect

Returns:

GetFrameOrigin

Point GetFrameOrigin ()

Returns:

FillGradientRectangle

void FillGradientRectangle (Rectangle rect, Orientation orientation, Color color1, Color color2)

Parameters:

rect
orientation
color1
color2

Returns:

CopyRectangle

void CopyRectangle (Rectangle rect, Point point)

Parameters:

rect
point

Returns:

DrawPoint

void DrawPoint (Point point)

Parameters:

point

Returns:

FillRectangleArray

void FillRectangleArray (Rectangles rects)

Parameters:

rects

Returns:

DrawLineArray

void DrawLineArray (Points start_points, Points end_points)

Parameters:

start_points
end_points

Returns:

DrawArcArray

void DrawArcArray (Arcs arcs)

Parameters:

arcs

Returns:

DrawArc

void DrawArc (Arc arc)

Parameters:

arc

Returns:

InsertPopupMenu

int InsertPopupMenu (Component component)

Parameters:

component

Returns:

DrawRectangleArray

void DrawRectangleArray (Rectangles rects)

Parameters:

rects

Returns:

DrawPointArray

void DrawPointArray (Points points)

Parameters:

points

Returns:

InsertChild

int InsertChild (Component component)

Parameters:

component

Returns:

FillArcArray

void FillArcArray (Arcs arcs)

Parameters:

arcs

Returns:

GetTextBaseline

int GetTextBaseline (String str)

Parameters:

str

Returns:

DeleteChild

void DeleteChild (String name)

Parameters:

name

Returns:

GetFrameSize

Dimension GetFrameSize ()

Returns:

GetTextSize

Dimension GetTextSize (String str)

Parameters:

str

Returns:

GetCursorPosition

Point GetCursorPosition ()

Returns:

DeletePopupMenu

void DeletePopupMenu ()

Returns:

DrawImage

void DrawImage (String image, Point position, ImageFlags flags)

Parameters:

image
position
flags

Returns:

DrawPolygon

void DrawPolygon (Points points)

Parameters:

points

Returns:

GetScreenOrigin

Point GetScreenOrigin ()

Returns:

DrawImages

void DrawImages (stringseq images, Rectangles rects, Rectangles content_rects, ImageFlags flags)

Parameters:

images
rects
content_rects
flags

Returns:

DrawText

void DrawText (String str, Point position)

Parameters:

str
position

Returns:

FillPolygon

void FillPolygon (Points points)

Parameters:

points

Returns:

SetFrameSize

void SetFrameSize (Dimension value)

Parameters:

value

Returns:

GetImageSize

Dimension GetImageSize (String image)

Parameters:

image

Returns:

FillEllipseArray

void FillEllipseArray (Rectangles rects)

Parameters:

rects

Returns:

DrawMultipleImages

void DrawMultipleImages (stringseq images, Points points, ImageFlags flags)

Parameters:

images
points
flags

Returns:

GetFrameRectangle

Rectangle GetFrameRectangle ()

Returns:

DrawTextArray

void DrawTextArray (stringseq strings, Points points)

Parameters:

strings
points

Returns:

DrawEllipseArray

void DrawEllipseArray (Rectangles rects)

Parameters:

rects

Returns:

FillRectangle

void FillRectangle (Rectangle rect)

Parameters:

rect

Returns:

SetFrameOrigin

void SetFrameOrigin (Point value)

Parameters:

value

Returns:

DrawPolyline

void DrawPolyline (Points points)

Parameters:

points

Returns:

GetFrameMinimumSize

Dimension GetFrameMinimumSize ()

Returns:

DrawLine

void DrawLine (Point start_point, Point end_point)

Parameters:

start_point
end_point

Returns:

GetScreenRectangle

Rectangle GetScreenRectangle ()

Returns:

DrawRectangle

void DrawRectangle (Rectangle rect)

Parameters:

rect

Returns:

SetFrameRectangle

void SetFrameRectangle (Rectangle rect)

Parameters:

rect

Returns:

FillEllipse

void FillEllipse (Rectangle rect)

Parameters:

rect

Returns:

Clear

void Clear ()

Returns:

GetRectangleOfMonitor

Rectangle GetRectangleOfMonitor ()

Returns:

DoesTrackMouse

boolean DoesTrackMouse ()

Returns:

SetTrackMouse

void SetTrackMouse (boolean flag)

Parameters:

flag

Returns:

GetLineWidth

int GetLineWidth ()

Returns:

SetLineWidth

void SetLineWidth (int value)

Parameters:

value

Returns:

GetMinimumWidth

int GetMinimumWidth ()

Returns:

SetMinimumWidth

void SetMinimumWidth (int value)

Parameters:

value

Returns:

GetDragItemName

String GetDragItemName ()

Returns:

SetDragItemName

void SetDragItemName (String value)

Parameters:

value

Returns:

GetDragCursorImage

String GetDragCursorImage ()

Returns:

SetDragCursorImage

void SetDragCursorImage (String value)

Parameters:

value

Returns:

DoesAllowWheelInput

boolean DoesAllowWheelInput ()

Returns:

SetAllowWheelInput

void SetAllowWheelInput (boolean flag)

Parameters:

flag

Returns:

IsDoubleBuffered

boolean IsDoubleBuffered ()

Returns:

SetDoubleBuffered

void SetDoubleBuffered (boolean flag)

Parameters:

flag

Returns:

GetKeyPressed

Key GetKeyPressed ()

Returns:

SetKeyPressed

void SetKeyPressed (Key key)

Parameters:

key

Returns:

GetArcFillMode

ArcFillMode GetArcFillMode ()

Returns:

SetArcFillMode

void SetArcFillMode (ArcFillMode value)

Parameters:

value

Returns:

GetArcDirection

ArcDirection GetArcDirection ()

Returns:

SetArcDirection

void SetArcDirection (ArcDirection value)

Parameters:

value

Returns:

GetTextFormat

RichText GetTextFormat ()

Returns:

SetTextFormat

void SetTextFormat (RichText value)

Parameters:

value

Returns:

GetDragNotValidCursorImage

String GetDragNotValidCursorImage ()

Returns:

SetDragNotValidCursorImage

void SetDragNotValidCursorImage (String value)

Parameters:

value

Returns:

DoesAllowKeyboardInput

boolean DoesAllowKeyboardInput ()

Returns:

SetAllowKeyboardInput

void SetAllowKeyboardInput (boolean flag)

Parameters:

flag

Returns:

GetFontName

String GetFontName ()

Returns:

SetFontName

void SetFontName (String value)

Parameters:

value

Returns:

GetDrawingImageArray

stringseq GetDrawingImageArray ()

Returns:

SetDrawingImageArray

void SetDrawingImageArray (stringseq values)

Parameters:

values

Returns:

GetFontClass

FontClass GetFontClass ()

Returns:

SetFontClass

void SetFontClass (FontClass value)

Parameters:

value

Returns:

GetPolygonFillMode

PolygonFillMode GetPolygonFillMode ()

Returns:

SetPolygonFillMode

void SetPolygonFillMode (PolygonFillMode value)

Parameters:

value

Returns:

IsValidDragSite

boolean IsValidDragSite ()

Returns:

SetValidDragSite

void SetValidDragSite (boolean flag)

Parameters:

flag

Returns:

GetWidth

int GetWidth ()

Returns:

SetWidth

void SetWidth (int value)

Parameters:

value

Returns:

DoesClipChildren

boolean DoesClipChildren ()

Returns:

SetClipChildren

void SetClipChildren (boolean flag)

Parameters:

flag

Returns:

GetDrawingMode

DrawingMode GetDrawingMode ()

Returns:

SetDrawingMode

void SetDrawingMode (DrawingMode value)

Parameters:

value

Returns:

GetMinimumHeight

int GetMinimumHeight ()

Returns:

SetMinimumHeight

void SetMinimumHeight (int value)

Parameters:

value

Returns:

GetFontSize

double GetFontSize ()

Returns:

SetFontSize

void SetFontSize (double value)

Parameters:

value

Returns:

CanRedraw

boolean CanRedraw ()

Returns:

SetCanRedraw

void SetCanRedraw (boolean flag)

Parameters:

flag

Returns:

IsEnabled

boolean IsEnabled ()

Returns:

SetEnabled

void SetEnabled (boolean flag)

Parameters:

flag

Returns:

GetHelpText

String GetHelpText ()

Returns:

SetHelpText

void SetHelpText (String value)

Parameters:

value

Returns:

GetDrawingColor

Color GetDrawingColor ()

Returns:

SetDrawingColor

void SetDrawingColor (Color color)

Parameters:

color

Returns:

GetMostRecentItemName

String GetMostRecentItemName ()

Returns:

GetDrawingBackgroundColor

Color GetDrawingBackgroundColor ()

Returns:

SetDrawingBackgroundColor

void SetDrawingBackgroundColor (Color color)

Parameters:

color

Returns:

GetFontStyle

FontStyle GetFontStyle ()

Returns:

SetFontStyle

void SetFontStyle (FontStyle value)

Parameters:

value

Returns:

GetHeight

int GetHeight ()

Returns:

SetHeight

void SetHeight (int value)

Parameters:

value

Returns:

HasBorder

boolean HasBorder ()

Returns:

SetHasBorder

void SetHasBorder (boolean flag)

Parameters:

flag

Returns:

GetLineStyle

LineStyle GetLineStyle ()

Returns:

SetLineStyle

void SetLineStyle (LineStyle value)

Parameters:

value

Returns:

AddActionListener

void AddActionListener (DrawingAreaListener listener)

Parameters:

listener

Returns:

PushAction

void PushAction (DrawingAreaAction action)

Parameters:

action

Returns:

CreateTimer

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