Manuais de utilizador para Macromedia fireworks mx 2004-extending fireworks

índice analítico

• Contents

  3
• Extending Fireworks Overview

  5
  • Prerequisites

    5
  • Installing an extension

    6
  • What’s new in Extending Fireworks MX 2004

    6
  • Conventions used in this guide

    7
  • Additional resources for extension writers

    7
• The Fireworks Object Model

  9
  • Using the Fireworks Object Model

    9
    • Accessing a Fireworks document

      10
    • Passing values

      10
    • Fireworks Object Model calls and API calls

      10
    • Formatting nonstandard data types

      11
      • Color string data type

        11
      • Mask data type

        11
      • Matrix data type

        11
      • Point data type

        11
      • Rectangle data type

        11
      • Resolution data type

        12
  • Global methods

    12
  • Core objects

    12
    • Document object

      13
    • The pngText object

      16
    • Errors object

      16
    • Files object

      17
    • Find object

      20
      • Finding and replacing text

        20
      • Finding and replacing fonts and styles

        20
      • Finding and replacing colors, fills, strokes, and effects

        21
      • Finding and replacing URLs

        21
      • Finding and replacing non-websafe colors with the closest websafe color

        21
  • The Fireworks object

    22
  • Objects within Fireworks documents

    26
    • Behavior object

      26
    • Brush object

      26
    • Contour object

      29
    • ContourNode object

      29
    • ContourNodeDynamicInfo object

      31
    • ControlPoint object

      31
    • Effect object

      32
      • Bevel object

        32
      • Blur object

        34
      • Blur More object

        34
      • Brightness/Contrast object

        34
      • Convert to Alpha object

        35
      • Curves object

        35
      • Drop Shadow object

        35
      • Find Edges object

        36
      • Gaussian Blur object

        36
      • Hue/Saturation object

        36
      • Inner Shadow object

        36
      • Invert object

        37
      • Levels object

        37
      • Sharpen object

        38
      • Sharpen More object

        38
      • Unsharp Mask object

        38
    • EffectList object

      38
    • Element object

      39
      • Group object

        40
      • Image object

        41
      • Instance object

        41
      • Hotspot object

        42
      • SliceHotspot object

        42
      • Path object

        43
      • Text object

        43
      • Texture object

        44
    • ElementMask object

      45
    • ExportFrameInfo object

      45
    • ExportOptions object

      46
    • ExportPaletteInfo object

      48
    • ExportSettings object

      49
    • Fill object

      51
    • Frame object

      52
    • FrameNLayerIntersection object

      52
    • Gradient object

      53
    • GradientNode object

      53
    • Guides object

      53
    • Layer object

      54
    • PathAttrs object

      54
    • Pattern object

      55
    • RectanglePrimitive object

      55
    • RegisterMoveParms object

      56
    • SingleTextRun object

      59
    • SmartShape object

      60
    • Style object

      61
    • TextAttrs object

      62
    • TextRuns object

      63
  • HTML export objects

    64
    • BehaviorInfo object

      64
    • BehaviorsList object

      65
    • exportDoc object

      66
    • ImageMap object

      68
    • ImagemapList object

      69
    • SliceInfo object

      69
    • Slices object

      71
  • Working with selected objects

    72
    • Working with properties for any selected object

      73
    • Working with specific properties for selected elements

      74
      • Hotspot

        74
      • SliceHotspot

        74
      • Path

        74
      • Group

        75
      • Instance

        75
      • Text

        75
      • RectanglePrimitive

        76
      • pathAttributes

        76
• Cross-Product Extensions

  77
  • Cross-product architecture

    77
    • XML and remote procedure calls (RPC)

      77
    • RPC client XML requests

      78
      • Object IDs

        79
      • Data node

        80
      • Parameters

        82
    • RPC server XML replies

      82
      • Error codes

        82
    • RPC and the Fireworks JavaScript DOM

      83
      • Generating stubs for nonstandard client types

        83
    • Security

      85
    • RPCMethods class

      85
      • RPCMethods.CreateAutoReleasePool()

        86
      • RPCMethods.DestroyAutoReleasePool()

        86
      • RPCMethods.AddToAutoReleasePool()

        86
      • RPCMethods.RemoveFromAutoReleasePool()

        87
      • RPCMethods.ReleaseObject()

        87
      • Creating auto-release blocks

        87
      • Accessing proxy objects

        88
    • A simple RPC example

      88
  • Flash panels

    90
    • How Flash panels and commands work

      90
    • Embedding API commands

      90
    • MMExecute()

      90
    • MMEndCommand()

      91
    • Using the API wrapper extension in Macromedia Flash

      91
      • Working with ActionScript (AS) files

        92
      • Guidelines for creating panels and commands

        92
    • Events

      92
      • How event handlers work

        92
      • Creating event handlers

        93
    • Publishing

      94
    • Debugging

      94
• Auto Shapes

  95
  • How Auto Shapes work

    95
  • Creating an Auto Shape

    96
    • Defining the shape

      96
      • Adding control points

        97
    • Handling the user interaction

      97
      • Fireworks messages

        98
      • Message handler functions

        98
      • Switch Statements

        100
      • Supporting functions and methods

        101
• Fireworks JavaScript API

  103
  • Using Fireworks API functions

    103
    • Zero-based indexes

      103
    • Passing null values

      103
    • Working with selected elements

      103
    • Palette or panel

      104
  • Document functions

    104
    • dom.addBehavior()

      104
      • Using the dom.addBehavior() function

        105
      • MM_nbGroup [down]

        105
      • MM_nbGroup [highlight]

        106
      • MM_nbGroup [image]

        106
      • MM_nbGroup [out]

        107
      • MM_simpleRollover

        107
      • MM_statusMessage

        107
      • MM_swapImage

        108
      • MM_swapImgRestore

        108
    • dom.addElementMask()

      109
    • dom.addFrames()

      109
    • dom.addGuide()

      110
    • dom.addNewHotspot()

      110
    • dom.addNewImage()

      111
    • dom.addNewImageViaCopy()

      111
    • dom.addNewImageViaCut()

      112
    • dom.addNewLayer()

      112
    • dom.addNewLine()

      113
    • dom.addNewOval()

      113
    • dom.addNewRectangle()

      114
    • dom.addNewRectanglePrimitive()

      114
    • dom.addNewSinglePointPath()

      115
    • dom.addNewStar()

      116
    • dom.addNewSymbol()

      116
    • dom.addNewText()

      117
    • dom.addSwapImageBehaviorFromPoint()

      117
    • dom.adjustExportToSize()

      118
    • dom.adjustFontSize()

      118
    • dom.align()

      119
    • dom.appendPointToHotspot()

      119
    • dom.appendPointToPath()

      120
    • dom.appendPointToSlice()

      120
    • dom.applyCharacterMarkup()

      121
    • dom.applyCurrentFill()

      121
    • dom.applyEffects()

      122
    • dom.applyFontMarkup()

      122
    • dom.applyStyle()

      123
    • dom.arrange()

      123
    • dom.attachTextToPath()

      124
    • dom.changeGuide()

      124
    • dom.changeSliceGuide()

      125
    • dom.clearJPEGMask()

      125
    • dom.clipCopy()

      126
    • dom.clipCopyAsPaths()

      126
    • dom.clipCopyFormats()

      127
    • dom.clipCut()

      127
    • dom.clipPaste()

      127
    • dom.clipPasteAsMask()

      128
    • dom.clipPasteAttributes()

      129
    • dom.clipPasteFromChannelToChannel()

      129
    • dom.clipPasteInside()

      130
    • dom.cloneSelection()

      131
    • dom.close()

      131
    • dom.convertAnimSymbolToGraphicSymbol()

      132
    • dom.convertToAnimSymbol()

      132
    • dom.convertToPaths()

      133
    • dom.convertToSymbol()

      133
    • dom.convolveSelection()

      134
    • dom.copyHtmlWizard()

      134
    • dom.copyToHotspot()

      135
    • dom.cropSelection()

      135
    • dom.deleteAllInDocument()

      136
    • dom.deleteFrames()

      136
    • dom.deleteLayer()

      137
    • dom.deletePointOnPath()

      137
    • dom.deleteSelection()

      138
    • dom.deleteSymbol()

      138
    • dom.detachInstanceFromSymbol()

      139
    • dom.detachTextFromPath()

      139
    • dom.distribute()

      139
    • dom.distributeLayerToFrames()

      140
    • dom.distributeSelectionToFrames()

      140
    • dom.dragControlPoint()

      141
    • dom.duplicateFrame()

      141
    • dom.duplicateLayer()

      142
    • dom.duplicateSelection()

      142
    • dom.duplicateSelectionToFrameRange()

      143
    • dom.duplicateSelectionToFrames()

      143
    • dom.duplicateSymbol()

      144
    • dom.duplicateSymbolForAlias()

      144
    • dom.elementsAt()

      144
    • dom.enableElementMask()

      145
    • dom.enableTextAntiAliasing()

      145
    • dom.enterElementMaskEditMode()

      146
    • dom.enterPaintMode()

      146
    • dom.exitElementMaskEditMode()

      147
    • dom.exitPaintMode()

      147
    • dom.exportOptions.loadColorPalette()

      147
    • dom.exportOptions.saveColorPalette()

      148
    • dom.exportTo()

      148
    • dom.fillSelectedPixels()

      149
    • dom.filterSelection()

      150
    • dom.filterSelectionByName()

      150
    • dom.findExportFormatOptionsByName()

      151
    • dom.findNamedElements()

      151
    • dom.flattenDocument()

      151
    • dom.flattenSelection()

      152
    • dom.getFontMarkup()

      152
    • dom.getPixelMask()

      153
    • dom.getSelectionBounds()

      153
    • dom.getShowGrid()

      153
    • dom.getShowRulers()

      154
    • dom.getSnapToGrid()

      154
    • dom.getTextAlignment()

      154
    • dom.group()

      155
    • dom.hasCharacterMarkup()

      155
    • dom.hideSelection()

      156
    • dom.importFile()

      156
    • dom.importSymbol()

      157
    • dom.importSymbolButNotAsAlias()

      157
    • dom.inLaunchAndEdit()

      158
    • dom.insertPointInPath()

      158
    • dom.insertSmartShapeAt()

      159
    • dom.isSelectionDirectlyAboveBitmapObject()

      159
    • dom.joinPaths()

      160
    • dom.knifeElementsFromPoint()

      160
    • dom.knifeElementsFromPoints()

      161
    • dom.linkElementMask()

      161
    • dom.makeFind()

      162
    • dom.makeGoodNativeFilePath()

      162
    • dom.makeActive()

      163
    • dom.mergeDown()

      163
    • dom.modifyPointOnPath()

      163
    • dom.motionBlurSelection()

      164
    • dom.moveBezierHandleBy()

      164
    • dom.moveElementMaskBy()

      165
    • dom.moveFillVectorHandleBy()

      165
    • dom.moveMaskGroupContentsBy()

      166
    • dom.movePixelMaskBy()

      167
    • dom.movePointOnHotspotBy()

      167
    • dom.movePointOnHotspotByWithFlags()

      168
    • dom.moveSelectedBezierPointsBy()

      168
    • dom.moveSelectionBy()

      169
    • dom.moveSelectionMaskBy()

      169
    • dom.moveSelectionTo()

      170
    • dom.moveSelectionToFrame()

      170
    • dom.moveSelectionToLayer()

      171
    • dom.moveSelectionToNewLayer()

      171
    • dom.pathCrop()

      172
    • dom.pathExpand()

      172
    • dom.pathInset()

      172
    • dom.pathIntersect()

      173
    • dom.pathPunch()

      173
    • dom.pathSimplify()

      174
    • dom.pathUnion()

      174
    • dom.previewInBrowser()

      174
    • dom.rebuildColorTable()

      175
    • dom.redo()

      175
    • dom.redraw()

      175
    • dom.reflectSelection()

      176
    • dom.removeAllGuides()

      176
    • dom.removeBehavior()

      177
    • dom.removeBrush()

      177
    • dom.removeCharacterMarkup()

      178
    • dom.removeElementMask()

      178
    • dom.removeFontMarkup()

      178
    • dom.removeFill()

      179
    • dom.removeGuide()

      179
    • dom.removeTransformation()

      180
    • dom.reorderFrame()

      180
    • dom.reorderLayer()

      181
    • dom.replaceButtonTextStrings()

      181
    • dom.replaceButtonTextStringsInInstances()

      182
    • dom.replaceTextString()

      182
    • dom.resizeSelection()

      183
    • dom.restoreJPEGMask()

      183
    • dom.restoreSelection()

      183
    • dom.reversePathTextDirection()

      184
    • dom.rotateDocument()

      184
    • dom.rotateSelection()

      185
    • dom.save()

      185
    • dom.saveCopyAs()

      186
    • dom.saveJPEGMask()

      186
    • dom.saveSelection()

      186
    • dom.scaleSelection()

      187
    • dom.selectAdjustPixelSel()

      187
    • dom.selectAll()

      188
    • dom.selectAllOnLayer()

      188
    • dom.selectChildren()

      189
    • dom.selectFeather()

      189
    • dom.selectInverse()

      190
    • dom.selectNone()

      190
    • dom.selectParents()

      190
    • dom.selectSimilar()

      191
    • dom.selectSimilarFromPoint()

      191
    • dom.sendEmail()

      192
    • dom.setAllLayersDisclosure()

      193
    • dom.setAnimInstanceLoopCount()

      193
    • dom.setAnimInstanceNumFrames()

      193
    • dom.setAnimInstanceOffsetDist()

      194
    • dom.setAnimInstanceRotationAmount()

      194
    • dom.setAnimInstanceScaleAmount()

      195
    • dom.setAnimInstanceStartEndOpacity()

      195
    • dom.setAnimInstanceStartFrame()

      196
    • dom.setBlendMode()

      196
    • dom.setBrush()

      196
    • dom.setBrushColor()

      197
    • dom.setBrushName()

      197
    • dom.setBrushNColorNTexture()

      198
    • dom.setBrushPlacement()

      198
    • dom.setButtonAutoSlice()

      198
    • dom.setButtonIncludeDownState()

      199
    • dom.setButtonIncludeOverWhileDownState()

      199
    • dom.setButtonShowDownOnLoad()

      200
    • dom.setButtonOptions()

      200
    • dom.setDefaultBrushAndFillColors()

      201
    • dom.setDefaultFillVector()

      201
    • dom.setDocumentCanvasColor()

      201
    • dom.setDocumentCanvasSize()

      202
    • dom.setDocumentCanvasSizeToDocumentExtents()

      202
    • dom.setDocumentCanvasSizeToSelection()

      203
    • dom.setDocumentImageSize()

      203
    • dom.setDocumentResolution()

      204
    • dom.setEffectName()

      204
    • dom.setElementMaskMode()

      204
    • dom.setElementMaskShowAttrs()

      205
    • dom.setElementName()

      205
    • dom.setElementVisible()

      206
    • dom.setElementVisibleByName()

      206
    • dom.setExportOptions()

      207
    • dom.setExportSettings()

      207
    • dom.setFill()

      207
    • dom.setFillColor()

      208
    • dom.setFillEdgeMode()

      208
    • dom.setFillNColor()

      209
    • dom.setFillNColorNTexture()

      209
    • dom.setFillPlacement()

      210
    • dom.setFillVector()

      210
    • dom.setFillVectorStart()

      210
    • dom.setGradientName()

      211
    • dom.setGridOrigin()

      211
    • dom.setGridSize()

      211
    • dom.setGridColor()

      212
    • dom.setGroupType()

      212
    • dom.setGuideColor()

      213
    • dom.setHotspotAltTag()

      213
    • dom.setHotspotColor()

      214
    • dom.setHotspotRectangle()

      214
    • dom.setHotspotShape()

      215
    • dom.setHotspotTarget()

      215
    • dom.setHotspotText()

      215
    • dom.setLayerDisclosure()

      216
    • dom.setLayerLocked()

      217
    • dom.setLayerName()

      217
    • dom.setLayerSharing()

      218
    • dom.setLayerVisible()

      218
    • dom.setMatteColor()

      219
    • dom.setPixelMask()

      220
    • dom.setOnionSkinning()

      220
    • dom.setOpacity()

      221
    • dom.setQuadrangle()

      221
    • dom.setRectRoundness()

      222
    • dom.setRectSides()

      222
    • dom.setSelectionBounds()

      223
    • dom.setSelectionMask()

      223
    • dom.setShowEdges()

      224
    • dom.setShowGammaPreview()

      224
    • dom.setShowGrid()

      224
    • dom.setShowGuides()

      225
    • dom.setShowRulers()

      225
    • dom.setShowSliceGuides()

      225
    • dom.setShowSliceOverlay()

      226
    • dom.setSliceAutonaming()

      226
    • dom.setSliceExportOptions()

      227
    • dom.setSliceFilename()

      227
    • dom.setSliceGuideColor()

      227
    • dom.setSliceHtml()

      228
    • dom.setSliceIsHtml()

      228
    • dom.setSnapToGrid()

      228
    • dom.setSnapToGuides()

      229
    • dom.setSymbolProperties()

      229
    • dom.setTextAlignment()

      230
    • dom.setTextAntiAliasing()

      230
    • dom.setTextAutoKern()

      230
    • dom.setTextCharSpacing()

      231
    • dom.setTextCustomAntiAliasOverSample()

      231
    • dom.setTextCustomAntiAliasSharpness()

      232
    • dom.setTextCustomAntiAliasStrength()

      232
    • dom.setTextFlow()

      232
    • dom.setTextHorizontalScale()

      233
    • dom.setTextLeading()

      233
    • dom.setTextOnPathMode()

      234
    • dom.setTextOnPathOffset()

      234
    • dom.setTextOrientation()

      234
    • dom.setTextParaIndent()

      235
    • dom.setTextParaSpacingAfter()

      235
    • dom.setTextParaSpacingBefore()

      236
    • dom.setTextRuns()

      236
    • dom.setTransformMode()

      236
    • dom.setTextRectangle()

      237
    • dom.setTextRectangleAuto()

      237
    • dom.setTextRectangleAutoFromPoint()

      238
    • dom.showAllHidden()

      238
    • dom.splitPaths()

      239
    • dom.swapBrushAndFillColors()

      239
    • dom.transformSelection()

      239
    • dom.tween()

      240
    • dom.undo()

      240
    • dom.updateSymbol()

      241
    • dom.ungroup()

      241
  • Fireworks functions

    241
    • fw.browseDocument()

      242
    • fw.browseForFileURL()

      242
    • fw.browseForFolderURL()

      242
    • fw.browseHelp()

      243
    • fw.checkFwJsVersion()

      243
    • fw.chooseBrowser()

      244
    • fw.chooseScriptTargetDialog()

      244
    • fw.closeDocument()

      245
    • fw.createDocument()

      245
    • fw.createDocumentWithDialog()

      246
    • fw.createFireworksDocument()

      246
    • fw.disableFlashDebugging()

      247
    • fw.dismissBatchDialogWhenDone()

      247
    • fw.enableFlashDebugging()

      247
    • fw.exportAndCopyHTMLCode()

      248
    • fw.exportDirectorAsLayers()

      248
    • fw.exportDirectorAsSlices()

      249
    • fw.exportDocumentAs()

      249
    • fw.exportFrames()

      250
    • fw.exportHtmlAndImages()

      250
    • fw.exportIllustrator()

      251
    • fw.exportLayers()

      251
    • fw.exportPSD()

      252
    • fw.exportSWF()

      253
    • fw.findApp()

      254
    • fw.findNext()

      255
    • fw.findOpenDocument()

      255
    • fw.getDocumentDOM()

      256
    • fw.getDocumentPath()

      256
    • fw.getFloaterGroupings()

      256
    • fw.getFloaterPosition()

      257
    • fw.getFloaterVisibility()

      257
    • fw.getHideAllFloaters()

      258
    • fw.getHTMLFileForScript()

      258
    • fw.getNumberOfTables()

      259
    • fw.getPref()

      259
    • fw.launchApp()

      259
    • fw.launchBrowserTo()

      260
    • fw.locateDocDialog()

      260
    • fw.openDocument()

      261
    • fw.popupColorPicker()

      262
    • fw.popupColorPickerOverMouse()

      262
    • fw.quit()

      263
    • fw.quitApplication()

      263
    • fw.readNthTable()

      264
    • fw.readPanelStateFromFile()

      264
    • fw.replace()

      264
    • fw.replaceAll()

      265
    • fw.revertDocument()

      265
    • fw.runScript()

      266
    • fw.saveAll()

      266
    • fw.saveDocument()

      267
    • fw.saveDocumentAs()

      267
    • fw.saveDocumentCopyAs()

      268
    • fw.saveJsCommand()

      268
    • fw.setActiveViewScale()

      269
    • fw.setActiveWindow()

      269
    • fw.setFloaterGrouping()

      270
    • fw.setFloaterPosition()

      270
    • fw.setFloaterVisibility()

      271
    • fw.setHideAllFloaters()

      272
    • fw.setPref()

      272
    • fw.setUpFindReplace()

      272
    • fw.toggleFloater()

      273
    • fw.ungroupPrimitives()

      273
    • fw.updateHTML()

      274
    • fw.writePanelStateToFile()

      274
    • fw.yesNoDialog()

      275
  • Property inspector functions

    275
    • fw.showPIWindow()

      275
    • fw.hidePIWindow()

      276
    • fw.isPIExpanded()

      276
    • fw.isPIVisible()

      276
    • fw.growPIWindow()

      277
    • fw.shrinkPIWindow()

      277
    • fw.setPIPosition()

      278
    • fw.getPIPosition()

      278
  • History panel functions

    278
    • fw.historyPalette.clearSteps()

      278
    • fw.historyPalette.copySteps()

      279
    • fw.historyPalette.getSelection()

      279
    • fw.historyPalette.getStepCount()

      280
    • fw.historyPalette.getStepsAsJavaScript()

      280
    • fw.historyPalette.getUndoState()

      280
    • fw.historyPalette.replaySteps()

      281
    • fw.historyPalette.saveAsCommand()

      281
    • fw.historyPalette.setSelection()

      282
    • fw.historyPalette.setUndoState()

      282
  • Using the common API

    283
    • app.toggleFloater()

      283
    • app.setFloaterVisibility()

      283
    • app.getRootDirectory()

      283
    • app.browseDocument()

      283
• Index

  285