Home » Adobe Manuals » Computer Software » Adobe 65011817 » Manual Viewer

Adobe 65011817 Extended User Guide - Page 56

Availability, Usage, Arguments, Returns, Description

UPC - 883919157368

Add to My Manuals
Save this manual to your list of manuals

Page 56 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 52 The Document object dom.breakLink() Availability Fireworks 3. Usage dom.breakLink() Arguments None. Returns Nothing. Description Breaks the link between the symbol and the instance. dom.changeCurrentPage() Availability Fireworks CS3. Usage dom.changeCurrentPage(pageNum) Arguments pageNum An long value that specifies the page number of the page that will become the active page. Returns Nothing. Description Changes the currently active page to the specified page number. The page number is in an array and the first page is numbered 0. dom.changeGuide() Availability Fireworks 3. Usage dom.changeGuide(currentPosition, newPosition, guidekind) Arguments currentPosition A floating-point value that specifies the current position of the guide.

Section	Page
Contents	3
Chapter 1: Extending Fireworks Overview	5
Prerequisites	5
Installing an extension	5
What’s new in Extending Fireworks CS4	6
Conventions used in this guide	9
Additional resources for extension writers	9
Chapter 2: The Fireworks Object Model	10
Using the Fireworks Object Model	10
Accessing a Fireworks document	10
Passing values	10
Fireworks Object Model calls and API calls	11
Formatting nonstandard data types	11
Color string data type	11
Mask data type	11
Matrix data type	12
Point data type	12
Rectangle data type	12
Resolution data type	12
Using Fireworks API functions	12
Zero-based indexes	12
Passing null values	12
Working with selected elements	12
Palette or panel	13
Using the common API	13
app.toggleFloater()	13
app.setFloaterVisibility()	13
app.getRootDirectory()	13
app.browseDocument()	13
Working with selected objects	13
Working with properties for any selected object	14
elementMask	14
effectList	14
Working with specific properties for selected elements	15
Hotspot	15
SliceHotspot	15
Path	15
Group	15
Instance	16
Text	16
RectanglePrimitive	16
pathAttributes	17
Global methods	17
alert(message)	17
confirm(message)	18
prompt(caption, text)	18
write(arg1, arg2, ..., argN)	18
WRITE_CSS	19
WRITE_HTML(arg1, arg2, ..., argN)	19
fw.setUseAGMRenderingForSelection()	20
Core objects	20
Errors object	20
Files object	20
File Reference object	22
Find object	23
Finding and replacing text	23
Finding and replacing fonts and styles	23
Finding and replacing colors, fills, strokes, and effects	24
Finding and replacing URLs	24
Finding and replacing non-websafe colors with the closest websafe color	25
System object	25
Adobe AIR Extension	25
AIRext.PreviewDocument()	25
AIRext.PackageApplication()	26
AIRext.CreatePackage()	26
AIRext.CheckCertificatePassword()	27
AIRext.SaveDigSigPassword()	27
AIRext.GetDigSigPassword()	28
AIRext.GetLastErrorLogName()	28
AIRext.GetAIRInstallPath()	29
AIRext.GetJREVersion()	29
AIRext.CreateCertificate()	29
Chapter 3: The Document object	31
Document object properties	31
The pngText property	33
Document functions	34
dom.addBehavior()	34
Using the dom.addBehavior() function	35
MM_nbGroup [down]	35
MM_nbGroup [highlight]	35
MM_nbGroup [image]	36
MM_nbGroup [out]	37
MM_simpleRollover	37
MM_statusMessage	37
MM_swapImage	37
MM_swapImgRestore	38
dom.addElementMask()	38
dom.addFrames()	39
dom.addGuide()	39
dom.addMasterPageLayer()	40
dom.addNewHotspot()	40
dom.addNewImage()	41
dom.addNewImageViaCopy()	41
dom.addNewImageViaCut()	42
dom.addNewLayer()	42
dom.addNewLine()	43
dom.addNewOval()	43
dom.addNewPage()	44
dom.addNewRectangle()	44
dom.addNewRectanglePrimitive()	45
dom.addNewSinglePointPath()	45
dom.addNewStar()	46
dom.addNewSubLayer()	47
dom.addNewSymbol()	47
dom.addNewText()	48
dom.addSwapImageBehaviorFromPoint()	48
dom.adjustExportToSize()	49
dom.adjustFontSize()	49
dom.align()	50
dom.appendPointToHotspot()	50
dom.appendPointToPath()	51
dom.appendPointToSlice()	51
dom.applyCharacterMarkup()	52
dom.applyCurrentFill()	52
dom.applyEffects()	52
dom.applyFontMarkup()	53
dom.applyStyle()	53
dom.arrange()	54
dom.attachTextInPath()	55
dom.attachTextToPath()	55
dom.breakLink()	56
dom.changeCurrentPage()	56
dom.changeGuide()	56
dom.changeNineScaleGuide()	57
dom.changeSliceGuide()	57
dom.clearJPEGMask()	58
dom.clipCopy()	59
dom.clipCopyAsPaths()	59
dom.clipCopyFormats()	60
dom.clipCopyJsToExecute()	60
dom.clipCut()	60
dom.clipPaste()	61
dom.clipPasteAsMask()	61
dom.clipPasteAttributes()	62
dom.clipPasteFromChannelToChannel()	63
dom.clipPasteInside()	63
dom.cloneSelection()	64
dom.close()	64
dom.convertAnimSymbolToGraphicSymbol()	65
dom.convertMarqueeToPath()	65
dom.convertPathToMarquee()	66
dom.convertToAnimSymbol()	66
dom.convertToPaths()	67
dom.convertToSymbol()	67
dom.convolveSelection()	68
dom.copyHtmlWizard()	69
dom.copyToHotspot()	69
dom.cropSelection()	70
dom.deleteAllInDocument()	70
dom.deleteFrames()	70
dom.deleteLayer()	71
dom.deletePageAt()	71
dom.deletePointOnPath()	72
dom.deleteSavedSelection()	72
dom.deleteSelection()	73
dom.deleteSymbol()	73
dom.detachInstanceFromSymbol()	74
dom.detachSharedLayer()	75
dom.distribute()	75
dom.distributeLayerToFrames()	76
dom.distributeSelectionToFrames()	76
dom.dragControlPoint()	76
dom.duplicateFrame()	77
dom.duplicateLayer()	78
dom.duplicatePage()	78
dom.duplicateSelection()	79
dom.duplicateSelectionToFrameRange()	79
dom.duplicateSelectionToFrames()	80
dom.duplicateSymbol()	80
dom.duplicateSymbolForAlias()	80
dom.elementsAt()	81
dom.enableElementMask()	81
dom.enableNineScale()	82
dom.enableTextAntiAliasing()	82
dom.enterPaintMode()	83
dom.exitPaintMode()	83
dom.exitSymbolEdit()	83
dom.exportElements()	84
dom.exportOptions.loadColorPalette()	84
dom.exportOptions.saveColorPalette()	85
dom.exportTo()	85
dom.fillSelectedPixels()	86
dom.filterSelection()	86
dom.filterSelectionByID()	87
dom.filterSelectionByName()	87
dom.findNamedElements()	88
dom.flattenDocument()	88
dom.flattenSelection()	89
dom.getFontMarkup()	89
dom.getLockGuides()	89
dom.getPageSetter()	90
dom.getParentLayerNum()	90
dom.getPixelMask()	90
dom.getSelectionBounds()	91
dom.getShowGrid()	91
dom.getShowGuides()	92
dom.getShowRulers()	92
dom.getSnapToGuides()	92
dom.getSnapToGrid()	93
dom.getTextAlignment()	93
dom.group()	94
dom.hasCharacterMarkup()	94
dom.hasMasterPage()	94
dom.hideSelection()	95
dom.importFile()	95
dom.importSymbol()	96
dom.importSymbolButNotAsAlias()	96
dom.inLaunchAndEdit()	97
dom.insertPointInPath()	97
dom.insertSmartShapeAt()	98
dom.insertSymbolAt()	98
dom.insertText()	99
dom.isMasterPageLayer()	99
dom.isSelectionDirectlyAboveBitmapObject()	100
dom.joinPaths()	100
dom.knifeElementsFromPoint()	100
dom.knifeElementsFromPoints()	101
dom.linkElementMask()	101
dom.lockNineScale()	102
dom.lockSelection()	102
dom.makeFind()	103
dom.makeActive()	103
dom.mergeDown()	104
dom.modifyPointOnPath()	104
dom.motionBlurSelection()	105
dom.moveBezierHandleBy()	105
dom.moveElementMaskBy()	106
dom.moveFillVectorHandleBy()	106
dom.moveMaskGroupContentsBy()	107
dom.moveNineScaleGuide()	107
dom.movePixelMaskBy()	108
dom.movePointOnHotspotBy()	108
dom.movePointOnHotspotByWithFlags()	109
dom.moveSelectedBezierPointsBy()	109
dom.moveSelectionBy()	109
dom.moveSelectionMaskBy()	110
dom.moveSelectionTo()	110
dom.moveSelectionToFrame()	111
dom.moveSelectionToLayer()	111
dom.moveSelectionToNewLayer()	112
dom.pageName()	112
dom.pathCrop()	113
dom.pathExpand()	113
dom.pathInset()	114
dom.pathIntersect()	114
dom.pathPunch()	115
dom.pathSimplify()	115
dom.pathUnion()	115
dom.placeTextInPath()	116
dom.previewInBrowser()	116
dom.previewAllPagesInBrowser()	116
dom.rebuildColorTable()	117
dom.redefineStyleByName()	117
dom.redo()	118
dom.redraw()	118
dom.redrawSmartShape()	119
dom.reflectSelection()	119
dom.removeAllGuides()	119
dom.removeBehavior()	120
dom.removeBrush()	120
dom.removeCharacterMarkup()	121
dom.removeElementMask()	121
dom.removeFontMarkup()	121
dom.removeFill()	122
dom.removeGuide()	122
dom.removeNineScale()	123
dom.removeTransformation()	123
dom.reorderFrame()	123
dom.reorderLayer()	124
dom.reorderPages()	125
dom.replaceButtonTextStrings()	125
dom.replaceButtonTextStringsInInstances()	126
dom.replaceTextString()	126
dom.resetNineScale()	127
dom.resizeSelection()	127
dom.restoreJPEGMask()	127
dom.restoreSelection()	128
dom.reversePathTextDirection()	128
dom.rotateDocument()	129
dom.rotateSelection()	129
dom.save()	130
dom.saveCopyAs()	130
dom.saveJPEGMask()	130
dom.saveSelection()	131
dom.scaleSelection()	132
dom.scalingGridRect()	132
dom.selectAdjustPixelSel()	133
dom.selectAll()	133
dom.selectAllOnLayer()	134
dom.selectChildren()	134
dom.selectFeather()	135
dom.selectInverse()	135
dom.selectNone()	135
dom.selectParents()	136
dom.selectSimilar()	136
dom.selectSimilarFromPoint()	137
dom.sendEmail()	137
dom.setAllLayersDisclosure()	138
dom.setAnimInstanceLoopCount()	138
dom.setAnimInstanceNumFrames()	139
dom.setAnimInstanceOffsetDist()	139
dom.setAnimInstanceRotationAmount()	140
dom.setAnimInstanceScaleAmount()	140
dom.setAnimInstanceStartEndOpacity()	141
dom.setAnimInstanceStartFrame()	141
dom.setBlendMode()	141
dom.setBrush()	142
dom.setBrushColor()	142
dom.setBrushName()	143
dom.setBrushNColor()	143
dom.setBrushNColorNTexture()	143
dom.setBrushPlacement()	144
dom.setButtonAutoSlice()	144
dom.setButtonIncludeDownState()	145
dom.setButtonIncludeOverWhileDownState()	145
dom.setButtonShowDownOnLoad()	145
dom.setButtonOptions()	146
dom.setDefaultBrushAndFillColors()	146
dom.setDefaultFillVector()	147
dom.setDocumentCanvasColor()	147
dom.setDocumentCanvasSize()	148
dom.setDocumentCanvasSizeToDocumentExtents()	148
dom.setDocumentCanvasSizeToSelection()	149
dom.setDocumentImageSize()	149
dom.setDocumentResolution()	150
dom.setEffectName()	150
dom.setElementLocked()	150
dom.setElementLockedByName()	151
dom.setElementMaskMode()	151
dom.setElementMaskShowAttrs()	152
dom.setElementName()	152
dom.setElementVisible()	153
dom.setElementVisibleByName()	153
dom.setExportOptions()	154
dom.setExportSettings()	154
dom.setFill()	155
dom.setFillColor()	155
dom.setFillEdgeMode()	155
dom.setFillNColor()	156
dom.setFillNColorNTexture()	156
dom.setFillPlacement()	157
dom.setFillVector()	157
dom.setFillVectorStart()	158
dom.setGradientName()	158
dom.setGridOrigin()	158
dom.setGridSize()	159
dom.setGridColor()	159
dom.setGroupType()	160
dom.setGuideColor()	160
dom.setHotspotAltTag()	160
dom.setHotspotColor()	161
dom.setHotspotRectangle()	161
dom.setHotspotShape()	162
dom.setHotspotTarget()	162
dom.setHotspotText()	163
dom.setLayerDisclosure()	164
dom.setLayerLocked()	164
dom.setLayerName()	165
dom.setLayerSharing()	165
dom.setLayerVisible()	166
dom.setMasterPage()	166
dom.setMatteColor()	167
dom.setNineScaleGuideColor()	167
dom.setPixelMask()	168
dom.setOnionSkinning()	168
dom.setOpacity()	169
dom.setPageName()	169
dom.setQuadrangle()	170
dom.setRectRoundness()	170
dom.setRectRoundnessMode()	171
dom.setRectSides()	171
dom.setSelectionBounds()	172
dom.setSelectionMask()	172
dom.setShowEdges()	172
dom.setShowGammaPreview()	173
dom.setShowGrid()	173
dom.setShowGuides()	174
dom.setShowRulers()	174
dom.setShowSliceGuides()	174
dom.setShowSliceOverlay()	175
dom.setSliceAutonaming()	175
dom.setSliceType()	175
dom.setSliceExportOptions()	176
dom.setSliceFilename()	176
dom.setSliceGuideColor()	177
dom.setSliceHtml()	177
dom.setSliceIsHtml()	177
dom.setSnapToGrid()	178
dom.setSnapToGuides()	178
dom.setSymbolProperties()	179
dom.setTextAlignment()	179
dom.setTextAntiAliasing()	179
dom.setTextAutoKern()	180
dom.setTextCharSpacing()	180
dom.setTextCustomAntiAliasOverSample()	181
dom.setTextCustomAntiAliasSharpness()	181
dom.setTextCustomAntiAliasStrength()	181
dom.setTextFlow()	182
dom.setTextHorizontalScale()	182
dom.setTextLeading()	183
dom.setTextOnPathMode()	183
dom.setTextOnPathOffset()	183
dom.setTextOrientation()	184
dom.setTextParaIndent()	184
dom.setTextParaSpacingAfter()	185
dom.setTextParaSpacingBefore()	185
dom.setTextRuns()	185
dom.setTransformMode()	186
dom.setTextRectangle()	186
dom.setTextRectangleAuto()	187
dom.setTextRectangleAutoFromPoint()	187
dom.setWebObjectsVisibility()	188
dom.shareLayerToPages()	188
dom.showAllHidden()	188
dom.splitPaths()	189
dom.swapBrushAndFillColors()	189
dom.transformSelection()	190
dom.tween()	190
dom.undo()	190
dom.updateSymbol()	191
dom.ungroup()	191
dom.unsetMasterPage()	192
Chapter 4: The Fireworks Object	193
Fireworks functions	196
fw.browseDocument()	196
fw.browseForFileURL()	197
fw.browseForFolderURL()	197
fw.browseHelp()	198
fw.checkFwJsVersion()	198
fw.chooseBrowser()	198
fw.chooseScriptTargetDialog()	199
fw.closeDocument()	199
fw.createDocument()	200
fw.createDocumentWithDialog()	200
fw.createFireworksDocument()	201
fw.currentWorkspaceName()	201
fw.dialogs.reloadCommonLibrary()	202
fw.dialogs.runEditGrids()	202
fw.dialogs.runEditGuides()	202
fw.dialogs.runNumericTransform()	203
fw.disableFlashDebugging()	203
fw.dismissBatchDialogWhenDone()	203
fw.enableFlashDebugging()	204
fw.exportAndCopyHTMLCode()	204
fw.exportCSSLayers()	205
fw.exportDirectorAsLayers()	205
fw.exportDirectorAsSlices()	206
fw.exportDocumentAs()	206
fw.exportFrames()	207
fw.exportHtmlAndImages()	207
fw.exportIllustrator()	208
fw.exportLayers()	208
fw.exportMXMLAndImages()	209
fw.exportPDF()	210
fw.exportPSD()	210
fw.exportSWF()	211
fw.findApp()	212
fw.findNext()	213
fw.findOpenDocument()	213
fw.getBlue()	214
fw.getDocumentDOM()	214
fw.getDocumentPath()	214
fw.getFamilyNameForPSFont()	215
fw.getFloaterGroupings()	215
fw.getFloaterPosition()	216
fw.getFloaterVisibility()	216
fw.getGreen()	217
fw.getHideAllFloaters()	217
fw.getHTMLFileForScript()	218
fw.getNumberOfTables()	218
fw.getPlatformNameForPSFont()	218
fw.getPref()	219
fw.getRed()	219
fw.getStyleNameForPSFont()	220
fw.internalNameToUIName()	220
fw.launchApp()	220
fw.launchBrowserTo()	221
fw.locateDocDialog()	221
fw.makeRGBColor()	222
fw.moveFocusToDoc()	223
fw.openDocument()	223
fw.openMultiDocument()	224
fw.popupColorPicker()	224
fw.popupColorPickerOverMouse()	225
fw.quit()	225
fw.quitApplication()	226
fw.readNthTable()	226
fw.readPanelStateFromFile()	226
fw.reloadCommonLibrary()	227
fw.replace()	227
fw.replaceAll()	228
fw.resetWarnings()	228
fw.revertDocument()	228
fw.runScript()	229
fw.saveAll()	229
fw.saveAs()	230
fw.saveDocument()	230
fw.saveDocumentAs()	231
fw.saveDocumentCopyAs()	231
fw.saveJsCommand()	232