docWindow Class Reference

Inherits docWindowBase.

Inheritance diagram for docWindow:

[legend]Collaboration diagram for docWindow:

[legend]List of all members.

Public Member Functions
void	ChangeRulerUnits (integer newStyleEnum)
void	Constructor (TemplateLayer inTemplate, string inName)
void	DocToMemory (XmlDocument inDoc, boolean readUserLayers=true)
ImageManager	DocumentImageManager ()
void	DrawGrid ()
DoubleClickableCanvas	DrawingCanvas ()
void	DrawObjects (Graphics eventGraphics)
void	DrawPageBackground (Graphics g)
void	DrawShapes (TilingGraphics inGraphics, integer inOffX, integer inOffY, double leftFineRes, double topFineRes, double rightFineRes, double bottomFineRes, ShapeLayer drawLayer=nil, boolean forcePrintableOnly=false)
void	DrawShapesUnclipped (TilingGraphics inGraphics, integer inOffX, integer inOffY, ShapeLayer drawLayer=nil, boolean forcePrintableOnly=false)
boolean	EditableTextItemSelected ()
void	EnableBumperCoordinatorTimer ()
void	EnableMenuItemsForWindow ()
void	EnableToolbarItems ()
void	FileName (string inName)
String	FileName ()
Boolean	GridDisplay ()
void	GridDisplay (boolean inDisplay)
double	GridSize ()
boolean	GridSnap ()
void	GridSnap (boolean inSnap)
void	HandleCentreNearestTemplate ()
void	HandleChangeActiveTemplate ()
void	HandleChangeSerialNumber ()
void	HandleChangeSingleBarcode ()
void	HandleChangeTable ()
void	HandleClear ()
void	HandleCopy ()
void	HandleCut ()
void	HandleDoubleClick (integer X, integer Y)
void	HandleEditGeneratedFill ()
Boolean	HandleFileSave ()
Boolean	HandleFileSaveAs ()
void	HandleGroup ()
void	HandleHelp ()
Boolean	HandleKeydown ()
void	HandleKeydownTab ()
void	HandleLoadTemplate ()
void	HandleLock (boolean lockit)
Boolean	HandleMouseDown (integer inX, integer inY)
void	HandleMouseDrag (integer inX, integer inY)
void	HandleMouseUp (integer inX, integer inY)
void	HandleMoveBackwards ()
void	HandleMoveForwards ()
void	HandleMoveToBack ()
void	HandleMoveToFront ()
void	HandleNudge (double NudgeX, double NudgeY)
void	HandlePageSetup ()
void	HandlePaste ()
void	HandlePasteSaveOLD ()
void	HandlePictureEffects ()
void	HandlePrint ()
void	HandlePrinterControl ()
void	HandleRedo ()
void	HandleReplicateInGrid ()
void	HandleReplicateTemplate ()
void	HandleReplicateToMatchingTemplates ()
boolean	HandleRevert ()
void	HandleRotation (integer inAngle)
integer	HandleSave ()
integer	HandleSaveChanges ()
void	HandleScroll ()
void	HandleSelectAll ()
void	HandleSelectByTemplate ()
boolean	HandleTemplateClipToMask ()
boolean	HandleTemplateDisplayOutline ()
boolean	HandleTemplateMenuSave ()
void	HandleToggleDisplayGuidelines ()
void	HandleTogglePrintableOnly ()
void	HandleToggleRulerScales ()
void	HandleToggleSnapToGuidelines ()
boolean	HandleToggleTemplateDisplayGuidelines ()
void	HandleToolsGrid ()
void	HandleToolsTemplateLabelSettings ()
void	HandleToolsTemplateSettings ()
void	HandleUndo ()
void	HandleUngroup ()
void	HandleViewEditGuidelinesLayer ()
void	HandleViewEditNormalLayer ()
void	HandleViewEditTemplateGuidelines ()
void	HandleViewLabelPage ()
void	HandleViewRefresh ()
void	HandleViewToggleTemplate ()
void	HandleZoomIn ()
void	HandleZoomOut ()
void	HandleZoomPercent (double inPercent)
void	HandleZoomShortcut ()
void	InitPageSetup ()
ADTemplateCentre	MakeTemplateCentre ()
void	MemoryToDoc (XMLDocument byref outDoc, boolean writeUserLayers=true)
void	Modified (boolean inModified)
Boolean	Modified ()
void	PrintObjects (TilingGraphics drawG)
void	RefreshCanvas ()
void	ReplaceActiveTemplate (TemplateLayer inTemplate)
void	RescaleAllLayers ()
void	ResizePanels ()
void	RevertToArrowTool ()
integer	ScrollH ()
integer	ScrollV ()
void	SetupLabelsPreview (integer inNumLabelsToPrint, integer inNumSkipping, integer inPreviewPageNumber, ShapeLayer inLayers[], ADTemplateCentre targetCentre)
void	SetWidthHeight (integer inWidth, integer inHeight)
TemplateLayer	Template ()
boolean	TemplateClipToMask ()
boolean	TemplateDrawOutline ()
void	ToggleGridSnap ()
void	ToggleTemplateGuidelinesLayer ()
void	ToggleTemplateLayerActive (boolean forceTemplateLayer=false)
void	UpdateCanvas ()
Public Attributes
Controls
Timer	BumperCoordinatorTimer
StaticText	ClipOpacityLabel
Slider	ClipOpacitySlider
StaticText	ClippingOpacityLabel
MouseEnterToolbarButton	CloseButton
MouseEnterToolbarButton	CopyButton
MouseEnterToolbarButton	CutButton
DoubleClickableCanvas	DrawingCanvasControl
ContextualMenu	EmptySpaceCMM
ESToolbarEndcap	EndCapMustHaveJustOne
ESToolbarSeparator	ESToolbarSeparator1
ESToolbarSeparator	ESToolbarSeparator2
ESToolbarSeparator	ESToolbarSeparator3
ESToolbarSeparator	ESToolbarSeparator5
MouseEnterToolbarButton	HelpButton
Canvas	hRuler
ScrollBar	hScrollControl
ContextualMenu	LockedShapeCMM
MouseEnterToolbarButton	NewButton
MouseEnterToolbarButton	OpenButton
MouseEnterToolbarButton	PasteButton
MouseEnterToolbarButton	PrintButton
MouseEnterToolbarButton	RedoButton
MouseEnterToolbarButton	SaveButton
ContextualMenu	ShapeCMM
Canvas	toggleRuler
ESToolbarController	ToolbarControl
MouseEnterToolbarButton	UndoButton
Canvas	vRuler
ScrollBar	vScrollControl
MouseEnterToolbarButton	ZoomInButton
MouseEnterToolbarButton	ZoomOutButton
Protected Member Functions
void	AdjustCursorToMatchToolState ()
void	ArrowToolSelect ()
boolean	CanPaste ()
void	ChangedActiveLayer ()
void	CloseChildren ()
void	CreateBuffer ()
void	DrawTemplatePageBoundaries (Graphics inGraphics)
boolean	EditableItemSelected ()
boolean	EditingAnyTemplateLayer ()
void	FitHeight ()
void	HideToolbar (boolean hidden, integer delta)
void	LineToolSelect ()
void	OvalToolSelect ()
void	PictureToolSelect ()
void	PrintLabelsFullPages (TilingGraphics g, integer numLabels, ShapeLayer savedMainLayer, TemplateLayer inTemplate, SerialNumberIncContext runningContext)
void	PrintLabelsPages (TilingGraphics g, integer numLabels, integer numToSkip)
void	PrintLabelsPartialPage (TilingGraphics g, integer numLabels, integer numToSkip, ShapeLayer savedMainLayer, TemplateLayer inTemplate, SerialNumberIncContext runningContext)
void	PrintNormalPage (TilingGraphics g)
void	RectangleToolSelect ()
void	RefreshAfterScaleChange ()
void	SelectAllWithin (RectShape boundShape)
void	TemplateClipToMask (boolean inDraw)
void	TemplateDrawOutline (boolean inDraw)
void	UpdateGrid (Graphics inGraphics, Boolean inForceUpdate)
void	UpdateGridPositions (Graphics inGraphics, integer inGridSize)
void	UpdateGridSize ()
void	ZZSnapDrawingCanvas ()
Package Attributes
DoubleClickableCanvas	DrawingCanvas
Scrollbar	hScroll
Color	mBackgroundColor
Dictionary	mBackgroundColors
docBundler	mBundler
docWindowBase	mChildWindows []
double	mClipOpacity
boolean	mClipToMask
integer	mCMMX
integer	mCMMY
ShapeLayer	mCurrentLayer
boolean	mCurrentlyDrawing
picture	mDrawBuffer
boolean	mDrawGuidelines
boolean	mDrawOldIndividualShapesApproach
boolean	mDrawOutline
boolean	mDrawTemplateGuidelines
string	mFileName
Boolean	mFirstDraw
double	mGridCoords []
double	mGridSize
GuidelinesLayer	mGuidelines
graphicRuler	mHRuler
boolean	mIgnoreMouseDown
boolean	mIgnoreResize
ImageManager	mImageManager
InspectorWindow	mInspector
boolean	mIsNewDocument
boolean	mIsPreviewWindow
integer	mLastMouseMoveX
integer	mLastMouseMoveY
double	mLastZoom
ShapeLayer	mLayers []
boolean	mLockUpdates
boolean	mModified
Boolean	mMouseInDrawCanvas
integer	mOldX
integer	mOldY
DragOutliner	mOutlineSelector
printerSetup	mPageSetup
string	mPageSetupString
PrintControlSettings	mPrintControlSettings
integer	mRulerStyle
integer	mScrollH
integer	mScrollV
SelHandles	mSelHandles
ADBaseShape	mShapeClipboard
boolean	mSnapToGuidelines
TemplateLayer	mTemplate
TilingGraphics	mTiler
boolean	mUseCMMClickXY
graphicRuler	mVRuler
DocWindowMenuItem	mWindowMenuItem
ScrollBar	vScroll

---

Detailed Description

The docWindow class encompases a drawing region and rulers. The docWindow object is the entry point for most operations within the application. The docWindow instance is the first object to be able to process user data. [AD even if not frontmost??]

The docWindow MouseDown, MouseDag and MouseUp calls determine which shape instance to operate on, then send appropriate messages to the shape instance.

The docWindow instance handles modfication of mouse co-ordinates to handle a scrolling drawing region or grid snapping before passing that data to the shape instance in question.

It also handles display of a user grid, if required. The docWindow instance informs the application and inspector window instances of the currently selected shape instance so those isntances can update as required.

The docWindow instance implements the majority of the menu items available within the application such as effect selection and 'Edit' menu items such as Cut, Copy and Paste.

The docWindow instance handles manipulation and display of document rulers including scales and scrolling of those rulers.

Window Sizing

This is a complex issue because of the interactions between the auto-sizing behaviour of the Window plus need to size other panels.
We must maintain a canvas drawing area sufficient to draw on the entire page size of the current template.
If the user sizes their drawing area larger than that we have an empty window and may draw page boundaries.
If the user sizes their window smaller than the min area required then we will be scrollable up to just enough space to keep the page boundaries in view.

Contextual Menus

Contextual menus in the docWindow are handled differently depending on being in clear space (see MouseDownCMMInEmptySpace) or on a shape.
If on a shape:

• select it
• display different menu depending if locked
• if they choose an Add Shape item, add the new shape

---

Member Function Documentation

void docWindowBase.AdjustCursorToMatchToolState

(

)

[protected, inherited]

void docWindowBase.ArrowToolSelect

(

)

[protected, inherited]

boolean docWindowBase.CanPaste

(

)

[protected, inherited]

void docWindowBase.ChangedActiveLayer

(

)

[protected, inherited]

void docWindowBase.ChangeRulerUnits

(

integer

newStyleEnum

)

[inherited]

void docWindowBase.CloseChildren

(

)

[protected, inherited]

void docWindowBase.Constructor	(	TemplateLayer	inTemplate,
		string	inName
	)			[inherited]

void docWindowBase.CreateBuffer

(

)

[protected, inherited]

void docWindowBase.DocToMemory	(	XmlDocument	inDoc,
		boolean	readUserLayers = true
	)			[inherited]

ImageManager docWindowBase.DocumentImageManager

(

)

[inherited]

void docWindowBase.DrawGrid

(

)

[inherited]

DoubleClickableCanvas docWindowBase.DrawingCanvas

(

)

[inherited]

void docWindowBase.DrawObjects

(

Graphics

eventGraphics

)

[inherited]

void docWindowBase.DrawPageBackground

(

Graphics

g

)

[inherited]

void docWindowBase.DrawShapes	(	TilingGraphics	inGraphics,
		integer	inOffX,
		integer	inOffY,
		double	leftFineRes,
		double	topFineRes,
		double	rightFineRes,
		double	bottomFineRes,
		ShapeLayer	drawLayer = nil,
		boolean	forcePrintableOnly = false
	)			[inherited]

void docWindowBase.DrawShapesUnclipped	(	TilingGraphics	inGraphics,
		integer	inOffX,
		integer	inOffY,
		ShapeLayer	drawLayer = nil,
		boolean	forcePrintableOnly = false
	)			[inherited]

void docWindowBase.DrawTemplatePageBoundaries

(

Graphics

inGraphics

)

[protected, inherited]

boolean docWindowBase.EditableItemSelected

(

)

[protected, inherited]

boolean docWindowBase.EditableTextItemSelected

(

)

[inherited]

boolean docWindowBase.EditingAnyTemplateLayer

(

)

[protected, inherited]

void docWindowBase.EnableBumperCoordinatorTimer

(

)

[inherited]

void docWindowBase.EnableMenuItemsForWindow

(

)

[inherited]

void docWindowBase.EnableToolbarItems

(

)

[inherited]

void docWindowBase.FileName

(

string

inName

)

[inherited]

String docWindowBase.FileName

(

)

[inherited]

void docWindowBase.FitHeight

(

)

[protected, inherited]

Boolean docWindowBase.GridDisplay

(

)

[inherited]

void docWindowBase.GridDisplay

(

boolean

inDisplay

)

[inherited]

double docWindowBase.GridSize

(

)

[inherited]

boolean docWindowBase.GridSnap

(

)

[inherited]

void docWindowBase.GridSnap

(

boolean

inSnap

)

[inherited]

void docWindowBase.HandleCentreNearestTemplate

(

)

[inherited]

void docWindowBase.HandleChangeActiveTemplate

(

)

[inherited]

void docWindowBase.HandleChangeSerialNumber

(

)

[inherited]

void docWindowBase.HandleChangeSingleBarcode

(

)

[inherited]

void docWindowBase.HandleChangeTable

(

)

[inherited]

void docWindowBase.HandleClear

(

)

[inherited]

void docWindowBase.HandleCopy

(

)

[inherited]

void docWindowBase.HandleCut

(

)

[inherited]

void docWindowBase.HandleDoubleClick	(	integer	X,
		integer	Y
	)			[inherited]

void docWindowBase.HandleEditGeneratedFill

(

)

[inherited]

Boolean docWindowBase.HandleFileSave

(

)

[inherited]

Boolean docWindowBase.HandleFileSaveAs

(

)

[inherited]

void docWindowBase.HandleGroup

(

)

[inherited]

void docWindowBase.HandleHelp

(

)

[inherited]

Boolean docWindowBase.HandleKeydown

(

)

[inherited]

void docWindowBase.HandleKeydownTab

(

)

[inherited]

void docWindowBase.HandleLoadTemplate

(

)

[inherited]

void docWindowBase.HandleLock

(

boolean

lockit

)

[inherited]

Boolean docWindowBase.HandleMouseDown	(	integer	inX,
		integer	inY
	)			[inherited]

void docWindowBase.HandleMouseDrag	(	integer	inX,
		integer	inY
	)			[inherited]

void docWindowBase.HandleMouseUp	(	integer	inX,
		integer	inY
	)			[inherited]

void docWindowBase.HandleMoveBackwards

(

)

[inherited]

void docWindowBase.HandleMoveForwards

(

)

[inherited]

void docWindowBase.HandleMoveToBack

(

)

[inherited]

void docWindowBase.HandleMoveToFront

(

)

[inherited]

void docWindowBase.HandleNudge	(	double	NudgeX,
		double	NudgeY
	)			[inherited]

void docWindowBase.HandlePageSetup

(

)

[inherited]

void docWindowBase.HandlePaste

(

)

[inherited]

void docWindowBase.HandlePasteSaveOLD

(

)

[inherited]

void docWindowBase.HandlePictureEffects

(

)

[inherited]

void docWindowBase.HandlePrint

(

)

[inherited]

void docWindowBase.HandlePrinterControl

(

)

[inherited]

void docWindowBase.HandleRedo

(

)

[inherited]

void docWindowBase.HandleReplicateInGrid

(

)

[inherited]

void docWindowBase.HandleReplicateTemplate

(

)

[inherited]

void docWindowBase.HandleReplicateToMatchingTemplates

(

)

[inherited]

boolean docWindowBase.HandleRevert

(

)

[inherited]

void docWindowBase.HandleRotation

(

integer

inAngle

)

[inherited]

integer docWindowBase.HandleSave

(

)

[inherited]

integer docWindowBase.HandleSaveChanges

(

)

[inherited]

void docWindowBase.HandleScroll

(

)

[inherited]

void docWindowBase.HandleSelectAll

(

)

[inherited]

void docWindowBase.HandleSelectByTemplate

(

)

[inherited]

boolean docWindowBase.HandleTemplateClipToMask

(

)

[inherited]

boolean docWindowBase.HandleTemplateDisplayOutline

(

)

[inherited]

boolean docWindowBase.HandleTemplateMenuSave

(

)

[inherited]

void docWindowBase.HandleToggleDisplayGuidelines

(

)

[inherited]

void docWindowBase.HandleTogglePrintableOnly

(

)

[inherited]

void docWindowBase.HandleToggleRulerScales

(

)

[inherited]

void docWindowBase.HandleToggleSnapToGuidelines

(

)

[inherited]

boolean docWindowBase.HandleToggleTemplateDisplayGuidelines

(

)

[inherited]

void docWindowBase.HandleToolsGrid

(

)

[inherited]

void docWindowBase.HandleToolsTemplateLabelSettings

(

)

[inherited]

void docWindowBase.HandleToolsTemplateSettings

(

)

[inherited]

void docWindowBase.HandleUndo

(

)

[inherited]

void docWindowBase.HandleUngroup

(

)

[inherited]

void docWindowBase.HandleViewEditGuidelinesLayer

(

)

[inherited]

void docWindowBase.HandleViewEditNormalLayer

(

)

[inherited]

void docWindowBase.HandleViewEditTemplateGuidelines

(

)

[inherited]

void docWindowBase.HandleViewLabelPage

(

)

[inherited]

void docWindowBase.HandleViewRefresh

(

)

[inherited]

void docWindowBase.HandleViewToggleTemplate

(

)

[inherited]

void docWindowBase.HandleZoomIn

(

)

[inherited]

void docWindowBase.HandleZoomOut

(

)

[inherited]

void docWindowBase.HandleZoomPercent

(

double

inPercent

)

[inherited]

void docWindowBase.HandleZoomShortcut

(

)

[inherited]

void docWindowBase.HideToolbar	(	boolean	hidden,
		integer	delta
	)			[protected, inherited]

void docWindowBase.InitPageSetup

(

)

[inherited]

void docWindowBase.LineToolSelect

(

)

[protected, inherited]

ADTemplateCentre docWindowBase.MakeTemplateCentre

(

)

[inherited]

void docWindowBase.MemoryToDoc	(	XMLDocument byref	outDoc,
		boolean	writeUserLayers = true
	)			[inherited]

void docWindowBase.Modified

(

boolean

inModified

)

[inherited]