MACROMEDIA DREAMWEAVER MX 2004-EXTENDING DREAMWEAVER Manual Download | Manualshive

Page: 286 / 296

background image

286

Index

clipCopyAsPaths() 126
clipCopyFormats() 127
clipCut() 127
clipPaste() 127
clipPasteAsMask() 128
clipPasteAttributes() 129
clipPasteFromChannelToChannel() 129
clipPasteInside() 130
cloneSelection() 131
close() 131
closeDocument() 245
color string 11
colors, finding and replacing  21
Common Application API 283
confirm() 12
Contour object 29
ContourNode object  29
ContourNodeDynamicInfo object 31
Contrast properties (Effect object) 34
ControlPoint object  31
conventions, in book 7
Convert to Alpha properties (Effect object) 35
convertAnimSymbolToGraphicSymbol() 132
convertToAnimSymbol() 132
convertToPaths() 133
convertToSymbol() 133
convolveSelection() 134
copyHtmlWizard() 134
copySteps() 279
copyToHotspot() 134, 135
core objects  12
CreateAutoReleasePool() 86
createDocument() 245
createDocumentWithDialog() 246
createFireworksDocument() 246
cropSelection() 135
Curves properties (Effect object) 35

D

data types

color string 11
mask 11
matrix 11
non-standard 11
point 11
rectangle 11
resolution 12

deleteAllInDocument() 136
deleteFrames() 136
deleteLayer() 137

deletePointOnPath() 137
deleteSelection() 138
deleteSymbol() 138
deprecated functions or arguments

dom.clipPasteInside() 130
dom.getPixelMask 153
dom.group() 155
dom.setAnimInstanceStartFrame() 196
dom.setGroupType() 212
dom.setPixelMask() 220
mask to image 40
mask to path 40

DestroyAutoReleasePool()  86
detachInstanceFromSymbol() 139
detachTextFromPath() 139
disableFlashDebugging() 247
dismissBatchDialogWhenDone() 247
distribute() 139
distributeLayerToFrames() 140
distributeSelectionToFrames() 140
Document object (core object) 13
documents, accessing objects  26
DOM (Document Object Model)  10
dom.addBehavior() 104
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

«
...
284
285
286
287
288
...
»

Summary of Contents for DREAMWEAVER MX 2004-EXTENDING DREAMWEAVER

Page 1: ...Extending Fireworks...

Page 2: ...n certain jurisdictions including internationally This guide contains links to third party Web sites that are not under the control of Macromedia and Macromedia is not responsible for the content on a...

Page 3: ...Core objects 12 The Fireworks object 22 Objects within Fireworks documents 26 HTML export objects 64 Working with selected objects 72 CHAPTER 3 Cross Product Extensions 77 Cross product architecture 7...

Page 4: ...4 Contents...

Page 5: ...Fireworks Prerequisites Because Fireworks extensions must be written in JavaScript this guide assumes that readers are familiar with JavaScript syntax and with basic programming concepts such as funct...

Page 6: ...nnot begin using some extensions until you restart Fireworks If you are running Fireworks when you install the extension you might be prompted to quit and restart the application To view basic informa...

Page 7: ...When copying the lines of code eliminate the continuation symbol and type the code as one line Curly braces around a function argument indicate that the argument is optional The following naming conve...

Page 8: ...8 Chapter 1 Extending Fireworks Overview...

Page 9: ...s object which is described in The Fireworks object on page 22 Numerous objects associated with Fireworks documents such as ExportOptions Guides Path Image and Text These objects and their properties...

Page 10: ...ollowing command sets the fifth brush in the third open document to a square shape fw documents 2 brushes 4 shape square The preceding example includes the following properties documents is a property...

Page 11: ...rectangle oval zlib compressed rle compressed or uncompressed If the value of maskKind is rectangle or oval the maskData string is ignored and a mask of the right shape is constructed that fills mask...

Page 12: ...age string Displays a string in a modal alert box along with an OK button Returns nothing confirm message string Displays a string in a modal alert box along with OK and Cancel buttons Returns true if...

Page 13: ...the output images It works for single and sliced images Sliced images get the default unless specific text is specified for a slice Corresponds to the text that is specified in File HTML Properties Im...

Page 14: ...sible gridSize point gridSize x is the horizontal grid size gridSize y is the vertical grid size guides object Guides object see Guides object on page 53 height integer Total height of the document in...

Page 15: ...ImageMap matteColor string A color string that corresponds to the matte color specified in the Optimize panel see Color string data type on page 11 This string is used by the useMatteColor property o...

Page 16: ...d with the resolution property Acceptable values are inch and cm textures array Array of Texture objects that are available for use in the document see Texture object on page 44 top integer Coordinate...

Page 17: ...is destroyed but it is useful for controlling access to a file copy docname1 docname2 string string Copies the file specified in the first argument to the file specified in the second argument Each a...

Page 18: ...Extension birthday png returns png If the filename has no extension an empty string is returned A filename that is expressed as file URL is acceptable getFilename docname string Returns just the filen...

Page 19: ...ument is a file path or a file URL to the file that you want to rename The newPlainFilename argument is the new name to assign to the file The rename method returns a URL path of the newly renamed fil...

Page 20: ...Defaults to false regExp Boolean If set to true the find and replace text is interpreted as a regular expression The default is false replace string Text to use as replacement text wholeWord Boolean...

Page 21: ...specified colors are replaced Property Data types Notes whatToFind string In the format url find string URL to find which is expressed as file URL replace string URL to use as replacement text which i...

Page 22: ...directory which is expressed as file URL appDir string The path to the directory that contains the Fireworks application which is expressed as file URL appExportSettingsDir string The path to the Expo...

Page 23: ...tory which is expressed as file URL appSmartShapeToolsDir string The path to the application s Auto Shape Tools directory which is expressed as file URL appStylesDir string The path to the Styles dire...

Page 24: ...rcle For example for a circle with a radius of 100 px the predecessor successor is 100 fw ellipseBCPConst pixels away from the point itself files object The FilesClass object used to perform file oper...

Page 25: ...Commands directory which is expressed as a file URL In Fireworks this folder is stored on a per user basis on multiuser systems Even on single user systems this folder is not inside the Fireworks inst...

Page 26: ...ng The JavaScript call for the behavior For legal values see Using the dom addBehavior function on page 105 event string Acceptable values are onMouseOver onClick onMouseOut onLoad and ANY the ANY arg...

Page 27: ...al value and blackness is the build up of black pixels as some tools brush over the same spot repeatedly like the felt tip sense_hdir_blackness float sense_hdir_hue float sense_hdir_lightness float se...

Page 28: ...se_vdir_size float sensitivity_x_y integer 0 to 100 where x is a value of pressure speed hDir vDir or random and y is a value of size angle opacity blackness scatter hue lightness or saturation For ex...

Page 29: ...Node objects on the contour see ContourNode object on page 29 Property Data type Notes dynamicInfo array Array of ContourNodeDynamicInfo objects on this ContourNode object see ContourNodeDynamicInfo o...

Page 30: ...e node point defines the line to move along object The RegisterMoveParms object containing the move parameters Use smartShape GetDefaultMoveParms to obtain this object then adjust properties as needed...

Page 31: ...hlights an object when a control point is dragged over it index integer Index for the control point name string Assigned name of the control point toolTip string Text to display when the user rolls th...

Page 32: ...ular movement object The RegisterMoveParms object containing the move parameters Use smartShape GetDefaultMoveParms to obtain this object then adjust properties as needed For a list of properties see...

Page 33: ...701850 EmbossFaceColor string A color string that specifies the color that is blended onto the face of the object when embossing see Color string data type on page 11 GlowStartDistance integer Specifi...

Page 34: ...A multiplier that is used to calculate the magnitude of the bevel slope Default effects all use 1 but other values should work For example 0 5 gives a more subtle slope and 2 0 gives a sharper slope S...

Page 35: ...80 rgb_points vector of points Each of these properties is a vector of points where x input level and y output level All x and y values must be between 0 and 255 and the points must be sorted in ascen...

Page 36: ...rily hidden The default value is true EffectMoaID string 3439b08d 1922 11d3 9bde00e02910d580 hue_amount integer 180 to 180 if hls_colorize is false 0 to 360 if hls_colorize is true saturation_amount i...

Page 37: ...oaID string d04ef8c1 71b4 11d1 8c8200a024cdc039 EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The default value is true source_low_rgb integer These source valu...

Page 38: ...ault value is true Property Data type Notes EffectMoaID string 1f2f2591 9db7 11d1 8cad00a024cdc039 EffectIsVisible Boolean If set to false the effect is included but temporarily hidden The default val...

Page 39: ...ment is an Auto Shape left float Can round to an integer mask object ElementMask object see ElementMask object on page 45 Returns null if the element has no element mask name string Can be null remove...

Page 40: ...ask to path were deprecated in Fireworks MX smartShapeCode string The body of code in the JavaScript file that defines the Auto Shape object transformMode string Can be one of the following AlwaysTran...

Page 41: ...ng the specified event removeTransformation none Undoes the previous transformation smartShapeToGlobalCoords point Converts the smartshape object s space into global transformed space see globalToSmar...

Page 42: ...otspot see Behavior object on page 26 color string Color in which the Hotspot is drawn in the Document window Default value is 00FFFF contour object Contour object for the Hotspot see Contour object o...

Page 43: ...ath object see Contour object on page 29 pathAttributes object PathAttrs object see PathAttrs object on page 54 randSeed float A 32 bit integer JavaScript integers hold only 31 bit numbers so it is st...

Page 44: ...floating point number textRuns object TextRuns object see TextRuns object on page 63 textureOffset point If the text has a textured brush or fill specifies the offset of the texture s origin transform...

Page 45: ...to false the mask remains present but does not visually affect the element in any way Default value is true linked Boolean If set to true moving the mask moves the element that owns it and vice versa...

Page 46: ...value If one value is positive and one is negative the positive value is always used This gives the following possibilities xSize 0 ySize 0 use min xSize ySize scaling xSize 0 ySize 0 use xSize scali...

Page 47: ...lse jpegQuality integer 1 to 100 the default value is 80 jpegSmoothness integer 0 to 8 the default value is 0 jpegSubsampling integer 0 to 4 the default value is 1 localAdaptive Boolean The default va...

Page 48: ...oolean The default value is true webSnapAdaptive Boolean The default value is true webSnapTolerance integer The default value is 14 xSize integer 100 000 to 100 000 default value is 0 See ExportOption...

Page 49: ...alse when the user exports a file exportFileStyle string Acceptable values are HTML and Images Images Only Dreamweaver LBI Director HTML CSS Layers Layers to Files Frames to Files Lotus Domino Macrome...

Page 50: ...and so on numeric1 generates a unique number 1 is first 2 is second and so on numeric01 generates a unique two digit number 01 is first 02 is second and so on doc name name of the file being exported...

Page 51: ...r od underscore the underscore character _ period the period character space the space character hyphen the hyphen character sliceUsingUrls Boolean If set to true use slice objects for slicing and sli...

Page 52: ...re blend and blend opaque textureBlend float 0 to 100 webDitherTransparent Boolean If set to true and shape is set to web dither then the second color in the ditherColors array is ignored and transpar...

Page 53: ...GradientNode object on page 53 opacityNodes array Array of GradientNode objects see GradientNode object on page 53 that identify the opacity ramp associated with a gradient Property Data type Notes co...

Page 54: ...tring Acceptable values are shared and not shared Property Data type Notes brush object Brush object see Brush object on page 26 brushColor string A color string that specifies the color that is used...

Page 55: ...roundness float A floating point value between 0 and 1 that specifies the roundness to use for the corners 0 is no roundness 1 is 100 roundness originalSides rectangle A rectangle that specifies the...

Page 56: ...e and maxAngle constrainX float The value to constrain the x coordinate Note the method constrainXKey must be used in conjunction with this method constrainXKey string Pass in the key that you want to...

Page 57: ...rToLinear float Determines the ratio of mouse movement to point movement along the line For example a value of 1 0 means that if the mouse moves 1 pixel the point moves 1 pixel along the line specifie...

Page 58: ...referenced point s y coordinate For example 1 0 means that when the mouse moves 1 pixel toward the bottom of the document the referenced point also moves 1 pixel toward the bottom of the document dis...

Page 59: ...ts to the right If minMaxRelative is set to false then the maximum x can be set to is 100 minX float The minimum value the x coordinate can move minY float The minimum value the y coordinate can move...

Page 60: ...turns the index number of the current control point currentControlPointName string Returns the name of the current control point currentMousePos point Location of the mouse during the current drag mes...

Page 61: ...00 valign top textBold Boolean Whether to make the specified text bold used only if use_textStyles is set to true textFont string The font to apply to text used only if use_textFont is set to true tex...

Page 62: ...Size property of the pathAttrs object when applying the style If set to false ignores the textSize property The default value is false use_textStyles Boolean If set to true applies the textStyles prop...

Page 63: ...ore space between lines of text Smaller numbers move the lines closer together The exact effect of this property number depends on the value of the leadingMode property leadingMode string The only acc...

Page 64: ...r data types and where appropriate acceptable values and notes All BehaviorInfo object properties are read only Property read only Data type Notes action integer Specifies the type of behavior 1 is St...

Page 65: ...horizontal pixel offset for the menu href string A link which is expressed as file URL For swap image behaviors it s the file URL for an external swap image file preload Boolean For swap image behavi...

Page 66: ...ge when you change the name of a file However if you use File Save As you can get multiple files with the same docID docSaveFolder string Contains the path of the directory into which the document was...

Page 67: ...s being exported without the extension for example Button includeHTMLComments Boolean The value of the Include HTML Comments preference which the export script interprets as appropriate For example if...

Page 68: ...ormatted files true or HTML formatted files false when the user exports a file Property read only or Method Data type Notes altText string The alternate text description for this slice if any behavior...

Page 69: ...return the coordinates for the first point var x imagemap xCoord 0 var y imagemap yCoord 0 It is possible to have negative values if the image map area is drawn so that it crosses the left or top side...

Page 70: ...in this image slice hasTargetText Boolean Set to true if the target text is not empty height integer Height of the image in pixels including row spans href string The URL link for this slice which is...

Page 71: ...n the specified frame without directory or extension information You can stop an image from being exported by setting its name to an empty string skipCell Boolean Set to true if this cell in the table...

Page 72: ...glePrimitive PathAttrs Image Property read only Data type Notes demoIndex zero based index Index for each file generated for multiple file button export doDemoHTML Boolean Corresponds to the Export Mu...

Page 73: ...ject You can return and set the following properties of any type of selected object top left width height visible opacity blendMode name mask To return the name of the selected object type the followi...

Page 74: ...g that has been applied to the currently selected Hotspot type the following code altTag fw selection 0 altText SliceHotspot SliceHotspot is a subclass of Hotspot A slice has all Hotspot properties pl...

Page 75: ...urn the instanceType for the currently selected instance type the following code instance fw selection 0 instanceType Text antiAliased antiAliasMode autoKern orientation pathAttributes Note For the co...

Page 76: ...gle type the following code roundness fw selection 0 roundness pathAttributes Several objects have the pathAttributes property The following list is the valid set of pathAttributes subproperties that...

Page 77: ...Fireworks XML and remote procedure calls RPC Applications written with Flash Actionscript 2 0 or C applications can control Fireworks MX 2004 by sending JavaScript instructions called remote procedure...

Page 78: ...s The XML request contains four pieces of information for Fireworks The type of operation to perform The name of the operation to perform The object on which the operation is performed Any parameters...

Page 79: ...to operate on the object with object ID 1 func obj 1 name undo release The release operation informs the server that the client has finished working on the specified object A release request must spec...

Page 80: ...bject ID used mainly for reporting and determining when errors occur in Fireworks Its JavaScript counterpart is Errors All other object IDs are generated when the object is created and may or may not...

Page 81: ...null The null type automatically coerces into the string type array type dictionary type and the server object type The null type cannot have any attributes or sub elements server object obj obj value...

Page 82: ...th a server object return obj value 23467 class FireworksDocument return Note When the server returns a server object it automatically retains the object on the client s behalf That is the object retu...

Page 83: ...ass The client can use the DOM document to determine the number and types of method parameters The DOM document uses more types in its prototypes than the RPC mechanism defines So several of the docum...

Page 84: ...trix A matrix is an array of nine float elements The elements start at the top row and go in row major order null null null Types map identically object server object or dictionary obj value 1 For an...

Page 85: ...or until the client that created them disconnects from the server RPCMethods class To use remote procedure calls Flash developers need to create an instance of a Fireworks object and thereafter manage...

Page 86: ...s None Returns Nothing Description Ends the auto release block and frees all allocated remote objects in the current auto release block function RPCMethods AddToAutoReleasePool Usage RPCMethods AddToA...

Page 87: ...eating auto release blocks Rather than constantly tracking which objects to release and how to relase them you can define blocks of code where you access the Fireworks DOM In these blocks of code the...

Page 88: ...C example This example creates a 200 x 200 pixel rectangle in Fireworks when a button in a Flash application is pressed To build a Flash application that uses RPC to create a Fireworks object 1 Downlo...

Page 89: ...Add Rectangle fwdoc addNewRectanglePrimitive rect 0 20 Set its color fwdoc setFillColor 00CC99 RPCMethods DestroyAutoReleasePool RPCMethods DestroyAutoReleasePool 7 Publish the SWF file When you publi...

Page 90: ...w macromedia com support fireworks documentation html You can construct these Macromedia Flash animations as interactive panels that work just as the Layers panel the Frames panel and other built in p...

Page 91: ...his argument holds a string used to notify the user of the error If endStatus is set to true notifyString is an empty string Returns Nothing Description This function should be called whenever the use...

Page 92: ...s You need to surround nested quotation marks need with backslash The following example prints John s example is really complex MMExecute alert John s example is really complex The movie size set in F...

Page 93: ...layer onFwHistoryChange Sent when the user creates an non scriptable history step onFwApplicationDeactivate Sent when the Fireworks application loses focus onFwApplicationActivate Sent when the Firew...

Page 94: ...Flash MX The Shockwave file is in the same place as the FLA file after publishing Debugging Fireworks provides two functions to help debug Flash panel ActionScript see fw enableFlashDebugging on page...

Page 95: ...nality like adding other shape objects or performing calculations as the Auto Shape is manipulated by the user The Auto Shape file also contains control points and properties stroke fill color and so...

Page 96: ...nodes 1 x 200 smartShape elem elements 0 contours 0 nodes 1 y 0 smartShape elem elements 0 contours 0 nodes 1 succX 200 smartShape elem elements 0 contours 0 nodes 1 succY 0 smartShape elem elements 0...

Page 97: ...the object You must define the control points for your Auto Shape before you can define what happens to the object when the user manipulates them The following code adds a single control point to the...

Page 98: ...sage every time the mouse moves during a drag operation as long as smartshape getsDragEvents is set to true See SmartShape object on page 60 EndDragControlPoint Fireworks sends this message when the d...

Page 99: ...ore information about how to get the properties of a smartShape object or wait until after a mouse event to change the object The following example uses the RegisterMove method to set the properties f...

Page 100: ...n a single Auto Shape object may not need to process every message Fireworks sends so only the useful messages are written into the JavaScript file using the case qualifier Effectively the JavaScript...

Page 101: ...sage handling functions For example the Cog Auto Shape JavaScript file Configuration Auto Shapes Cog jsf contains user defined functions near the bottom of the file These functions perform calculation...

Page 102: ...102 Chapter 4 Auto Shapes...

Page 103: ...ay 1 represents the second item and so on For example the following command deletes the second layer of the active Fireworks document fw getDocumentDOM deleteLayer2 Functions that take aframeIndex arg...

Page 104: ...simply type dom functionName In place of dom you must type fw getDocumentDOM or fw documents documentIndex For example How a function looks in this manual dom addNewHotspot How you must type it fw get...

Page 105: ...ments type barName target swapFrame fileName preload Pass down for type Pass navbar1 for the name of the navigation bar target specifies the slice to which the behavior is attached Pass 1 for this val...

Page 106: ...for highlighting on mouse down pass 1 or not pass 0 If you pass 1 use the next two arguments to specify the frame or image to be used downHighlightFrame is an integer value that specifiesthe frame to...

Page 107: ...a navigation bar restore behavior Example fw getDocumentDOM addBehavior MM_nbGroup out onMouseOut 1 MM_simpleRollover Availability Fireworks 3 Arguments None Description Adds a simple rollover behavio...

Page 108: ...the frame or file to swap If you specified a frame to use in swapFrame pass an empty text string If you want to specify a filename and you passed 1 for swapFrame pass the string for the relative URL o...

Page 109: ...ected when calling this function If selecting more than one element or none at the time this function is called Fireworks throws an exception dom addFrames Availability Fireworks 3 enhanced in Firewor...

Page 110: ...that position is a y coordinate if vertical it is an x coordinate Returns Nothing Description Adds a guide to the document If a guide already exists at the specified position this function has no effe...

Page 111: ...e 11 You cannot create an image that is larger than the document therefore if you pass in a rectangle with bounds larger than the document size you can create an image that is constrained to the docum...

Page 112: ...ed directly above the active bitmap You must have a current pixel selection for this to succeed The selection is cut from the previously active bitmap The new bitmap appears with Fireworks in paint mo...

Page 113: ...a new line between the specified coordinates fw getDocumentDOM addNewLine x 64 5 y 279 5 x 393 5 y 421 5 dom addNewOval Availability Fireworks 3 Usage dom addNewOval boundingRectangle Arguments boundi...

Page 114: ...uses the document s current default path attributes and is added on the current frame and layer Example The following command adds a new rectangle with no round corners within the specified coordinate...

Page 115: ...ty Fireworks 3 Usage dom addNewSinglePointPath controlPointFirst controlPointLast bCopyAttrs Arguments controlPointFirst mjainPoint and controlPointLast Points that specify the x y coordinates of the...

Page 116: ...centerPoint Specifies the center point of the star or polygon see Point data type on page 11 outsidePoint Specifies a point on the radius of the star or polygon Returns Nothing Description Adds a new...

Page 117: ...gle data type on page 11 bInitFromPrefs If bInitFromPrefs is false the default values for all style properties are used If it is true the most recent values set by the user are used Returns Nothing De...

Page 118: ...s If a document has slices sizeInBytes adjusts the size of all exported images so that the sum of the sizes is greater than or equal to sizeInBytes bOkToIncreaseSize Specifies whether the export file...

Page 119: ...m appendPointToHotspot Availability Fireworks 3 Usage dom appendPointToHotspot pt tolerance Arguments pt A point that specifies the x y coordinates of the point to be added see Point data type on page...

Page 120: ...o add a point to the end of the path pass a large number controlPointFirst mainPoint and controlPointLast Points that specify the x y coordinates of the preceding control point the main point and the...

Page 121: ...underline and fwplain which was added in Fireworks 4 for text with no character markup Returns Nothing Description Applies the specified character markup to the selected text dom applyCurrentFill Ava...

Page 122: ...hadow object on page 35 fw getDocumentDOM applyEffects category Untitled effects EffectIsVisible true EffectMoaID a7944db8 6ce2 11d1 8c76000502701850 ShadowAngle 315 ShadowBlur 4 ShadowColor 000000a6...

Page 123: ...references the second and so on Returns Nothing Description Applies the specified style to the selection Example The following command applies the first style that Fireworks encounters named Style 7 w...

Page 124: ...m changeGuide currentPosition newPosition guidekind Arguments currentPosition A floating point value that specifies the current position of the guide newPosition A floating point value that specifies...

Page 125: ...gneticDrag is true Fireworks also moves slice guides between the old guide position and the new position This action resizes and possibly deletes rectangular slices that do not abut the slice guide at...

Page 126: ...n to the Clipboard Example The following command copies the selected items to the Clipboard fw getDocumentDOM clipCopy dom clipCopyAsPaths Availability Fireworks MX Usage dom clipCopyAsPaths Arguments...

Page 127: ...ies the selection to the Clipboard using the specified format dom clipCut Availability Fireworks 3 Usage dom clipCut Arguments None Returns Nothing Description Cuts the selection to the Clipboard Exam...

Page 128: ...e document Example The following command pastes the Clipboard contents into the document If there is a need for resampling Fireworks asks the user to decide how to resample fw getDocumentDOM clipPaste...

Page 129: ...e selection Example The following command applies the attributes that were copied to the Clipboard onto the selected items fw getDocumentDOM clipPasteAttributes dom clipPasteFromChannelToChannel Avail...

Page 130: ...ing that specifies how resampling should be done if the resolution of the Clipboard contents doesn t match the resolution of the document Acceptable values for whatIfResolutionDifferent are resample d...

Page 131: ...on top of the original items fw getDocumentDOM cloneSelection See also dom duplicateSelection dom close Availability Fireworks 3 Usage dom close bPromptToSaveChanges Arguments bPromptToSaveChanges If...

Page 132: ...t that specifies the distance the animation will move in pixels see Point data type on page 11 For example passing x 100 y 25 animates the symbol to the right 100 pixels and down 25 pixels rotationAmo...

Page 133: ...ments None Returns Nothing Description Converts the selected text items into editable paths Example The following command converts the selected text items into editable paths fw getDocumentDOM convert...

Page 134: ...fficients kernelValues An array of integers that defines the values for specific filter patterns affectsAlpha A Boolean value true means the convolution filter affects the transparency of the bitmap f...

Page 135: ...are selected Acceptable values for whatIfMultipleSelected are single creates a single Hotspot that has the same bounding rectangle as the selection multiple creates one Hotspot for each item and ask u...

Page 136: ...Availability Fireworks MX Usage dom deleteAllInDocument Arguments None Returns Nothing Description Deletes all the objects in the document dom deleteFrames Availability Fireworks 3 Usage dom deleteFr...

Page 137: ...s contourIndex An integer value that specifies the contour that contains the point to be deleted starting with 0 although to specify the current contour pass 1 here pointIndex An integer value that sp...

Page 138: ...le If Fireworks is not in bitmap mode the following command deletes the selected items If Fireworks is in bitmap mode the following command fills the selected items to transparent fw getDocumentDOM de...

Page 139: ...eFromSymbol Arguments None Description Breaks the links between the selected instances and the owning symbols Returns Nothing dom detachTextFromPath Availability Fireworks 3 Usage dom detachTextFromPa...

Page 140: ...cified layer to the frames of the document adding frames if necessary The first item on the layer goes to the first frame the second item to the second frame and so on New frames are added to the docu...

Page 141: ...osh is pressed Returns Nothing Description Drags the specified control point to the new location dom duplicateFrame Availability Fireworks 3 usage dom duplicateFrame frameIndex howMany where bDupeSele...

Page 142: ...pass 1 here howMany An optional integer that specifies how many times to duplicate the layer If omitted the layer is duplicated once where An optional argument that specifies where to put the new laye...

Page 143: ...the items should be copied starting with 0 although to specify the current frame pass 1 here If both arguments are the same duplicates are placed only on that frame If the range includes the current...

Page 144: ...licateSymbolForAlias Availability Fireworks 3 Usage dom duplicateSymbolForAlias Arguments None Returns Nothing Description If any symbol instances are selected this function makes duplicate symbols of...

Page 145: ...ean value that toggles the element mask between enabled true and disabled false selectAndEnterPaintModeIfPossible A Boolean value that determines the mode for the mask If selectAndEnterPaintModeIfPoss...

Page 146: ...or the selection If the selection contains no mask elements Fireworks throws an exception dom enterPaintMode Availability Fireworks 3 with the argument newSelectionMask added in Fireworks MX Usage dom...

Page 147: ...tion has no effect dom exitPaintMode Availability Fireworks 3 Usage dom exitPaintMode Arguments None Returns Nothing Description Leaves bitmap mode Has no effect if Fireworks is not in bitmap mode dom...

Page 148: ...panel should be saved Do not specify a file extension the act extension is added automatically Returns Nothing Description Saves the values in dom exportOptions paletteEntries to the specified color...

Page 149: ...is generated using the values passed for tolerance edgemode and featherAmt This behavior is the same as if the Magic Wand tool were used at the clickPt location tolerance An integer between 0 and 255...

Page 150: ...n sets hue to 30 and saturation to 20 fw getDocumentDOM filterSelection EffectMoaID 3439b08d 1922 11d3 9bde00e02910d580 hls_colorize true hue_amount 30 lightness_amount 0 saturation_amount 20 dom filt...

Page 151: ...n Looks for a set of export settings that were saved with the specified name dom findNamedElements Availability Fireworks 4 Usage dom findNamedElements name Arguments name A case sensitive string that...

Page 152: ...scription Flattens the selection into a single pixel image This action is the same behavior as the Merge Images command dom getFontMarkup Availability Fireworks 3 Usage dom getFontMarkup fontAttribute...

Page 153: ...k data type on page 11 Description Gets the current pixel selection mask The result of this call could be used to call dom enableElementMask on page 145 or dom enterPaintMode on page 146 dom getSelect...

Page 154: ...guments None Returns true if the rulers are visible false otherwise Description Determines whether the rulers are visible dom getSnapToGrid Availability Fireworks 3 Usage dom getSnapToGrid Arguments N...

Page 155: ...group the items Acceptable values are normal mask to image and mask to path If the argument is omitted normal is assumed In Fireworks 4 mask to image and mask to path are deprecated Returns Nothing De...

Page 156: ...s fileURL The filename of the file to be imported which is expressed as a file URL boundingRectangle A rectangle that specifies the size to make the imported file see Rectangle data type on page 11 If...

Page 157: ...it is false the symbol is added only to the library bAllowUI If bAllowUI is true and fileURL is a Fireworks document that contains symbols then a dialog box lets the user specify which symbols to imp...

Page 158: ...h and edit operation dom insertPointInPath Availability Fireworks 3 Usage dom insertPointInPath contourIndex ptToInsertBefore tParameter controlPointFirst mainPoint controlPointLast Arguments contourI...

Page 159: ...y Determines whether the new shape object should have the blend mode and opacity settings set for the Auto Shape Tools set by the user in the Property inspector or use standard values The bUseToolBlen...

Page 160: ...mPoint Availability Fireworks 3 Usage dom knifeElementsFromPoint from tolerance Arguments from A point that specifies the x y coordinates of the point that the user clicked see Point data type on page...

Page 161: ...ditional items within the specified tolerance This action is similar to using the Knife tool with a drag operation See also dom knifeElementsFromPoint dom linkElementMask Availability Fireworks 4 Usag...

Page 162: ...ct Description Creates an object of class Find to perform a search and replace operation in a document dom makeGoodNativeFilePath Availability Fireworks 3 Usage dom makeGoodNativeFilePath fileURL Argu...

Page 163: ...s Succeeds only if the object immediately below the selection is a bitmap See dom isSelectionDirectlyAboveBitmapObject on page 159 dom modifyPointOnPath Availability Fireworks 3 Usage dom modifyPointO...

Page 164: ...ailability Fireworks MX 2004 Usage dom motionBlurSelection typeStr angle distance samples Arguments typeStr A string that specifies the type of blur to apply Valid values are linear radial and zoom an...

Page 165: ...ation that is right by 1 pixel and down by 2 pixels Returns Nothing Description Moves the specified point s B zier handles by a certain amount dom moveElementMaskBy Availability Fireworks 4 Usage dom...

Page 166: ...ndles might move in sync when the specified handle is moved Returns Nothing Description If the selection has a fill that uses a fill vector for example a gradient fill this function adjusts the handle...

Page 167: ...nt without moving the pixels that are within the selection dom movePointOnHotspotBy Availability Fireworks 3 Usage dom movePointOnHotspotBy ptToModifyIndex delta Arguments ptToModifyIndex A zero based...

Page 168: ...for giving slices a unique name so their behaviors remain unaffected Returns Nothing Description If the selection is a Hotspot or slice of the polyline variety this function moves a point on the Hots...

Page 169: ...bject Returns Nothing Description Moves the selected items by the specified amount or makes a copy of them and offsets them from the original by the specified amount Example The following command move...

Page 170: ...on moves the whole object Returns Nothing Description Moves or copies the selection to the specified location Example The following command copies only the selected parts of a path to the specified co...

Page 171: ...alog box to let the user decide If whatIfMultipleSelected is omitted or null ask user is assumed elementIndex A zero based index added in Fireworks 4 that specifies the element before which the moved...

Page 172: ...loating point value that specifies the new width of the selected paths in pixels miter A floating point value that specifies the new miter angle of the selected paths in pixels This argument is ignore...

Page 173: ...join is not miter join Acceptable values are bevel round and miter Returns Nothing Description Performs an inset operation on the selected paths dom pathIntersect Availability Fireworks 3 Usage dom pa...

Page 174: ...Nothing Description Performs a simplify operation on the selected paths dom pathUnion Availability Fireworks 3 Usage dom pathUnion Arguments None Returns Nothing Description Performs a union operation...

Page 175: ...hing Description Rebuilds the color table for the current export settings of the document This is the same behavior as choosing Rebuild Color Table from the Color Table panel dom redo Availability Fir...

Page 176: ...iz is true the items are reflected horizontally bVert If bVert is true the items are reflected vertically opts Acceptable values are transformAttributes autoTrimImages and autoTrimImages transformAttr...

Page 177: ...he behavior to be removed starting with 0 although to specify the end location pass 1 here This argument is optional If you omit both optional arguments this function removes all events from selected...

Page 178: ...if the element not the element mask is an image Acceptable values for whatIfElementIsAnImage are apply apply the element mask to the image before discarding the element mask discard discard the elemen...

Page 179: ...moveGuide Availability Fireworks 3 Usage dom removeGuide position guidekind Arguments position A floating point value that specifies the position of the guide to be removed guidekind Acceptable values...

Page 180: ...sed index that specifies which frame to move or copy frameToPutItBefore A zero based index that specifies where to place the frame that is to be moved or copied For example if you pass 1 for frameToMo...

Page 181: ...other specified layer dom replaceButtonTextStrings Availability Fireworks 3 Usage dom replaceButtonTextStrings newString uniformAttrs Arguments newString Specifies the string to be used as replacement...

Page 182: ...hing Description Replaces selected button text items with the specified string Button text items are defined as the topmost text items on each frame See also dom replaceButtonTextStrings dom replaceTe...

Page 183: ...iption Resizes the selection to the specified pixel width and height keeping the top left corner of the selection in place dom restoreJPEGMask Availability Fireworks 4 Usage dom restoreJPEGMask Argume...

Page 184: ...ments None Returns Nothing Description For all text on a path items in the selection it reverses the direction of the text along the path dom rotateDocument Availability Fireworks 3 Usage dom rotateDo...

Page 185: ...clockwise by the specified number of degrees Rotating 270 is the same behavior as rotating 90 counterclockwise dom save Availability Fireworks 3 Usage dom save bOkToSaveAs Arguments bOkToSaveAs If thi...

Page 186: ...escription Saves a copy of the document in a specified directory with a specified name This function does not affect the document s filePathForSave or isDirty properties dom saveJPEGMask Availability...

Page 187: ...vertical axes Acceptable values are 0 0 or greater a value of 1 represents 100 2 represents 200 and so on opts Acceptable values are transformAttributes autoTrimImages and autoTrimImages transformAtt...

Page 188: ...pecifying the amount by which to adjust Any integer is acceptable Returns Nothing Description Expands or reduces the pixel selection by the specified number of pixels selects a border of pixels or smo...

Page 189: ...hing Description Selects the children if any of the selection For example if a group is selected the selection changes from the group to the individual members of the group See also dom selectParents...

Page 190: ...tion inverts the pixel selection dom selectNone Availability Fireworks 3 Usage dom selectNone Arguments None Returns Nothing Description Deselects any selected items If Fireworks is in image edit mode...

Page 191: ...tialias and feather featherAmt An integer that specifies the number of pixels to feather This value is ignored if edgemode is not feather combinemode Specifies how to combine the new selection mask wi...

Page 192: ...lues are replace add subtract and intersect Returns Nothing Description Behavior is almost identical to dom selectSimilar except that the new mask is calculated from the color at the specified locatio...

Page 193: ...etAnimInstanceLoopCount Availability Fireworks 3 deprecated in 4 in favor of dom setAnimInstanceNumFrames Usage dom setAnimInstanceLoopCount loopCount Arguments loopCount An integer that corresponds t...

Page 194: ...the symbol to the right by 100 pixels and down by 25 pixels Returns Nothing Description Sets the distance in pixels to animate the currently selected animation element See also dom convertToAnimSymbo...

Page 195: ...its current size and pass 200 to scale it to twice its current size To specify no scaling pass 100 Returns Nothing Description Sets the scale amount to animate the currently selected animation instanc...

Page 196: ...hen a multiframe image instance is selected Returns Nothing Description Sets the start frame of the selected instances of multiframe image symbols dom setBlendMode Availability Fireworks 3 Usage dom s...

Page 197: ...on page 11 Returns Nothing Description Sets the brush color of the selection to the specified color See also dom setBrushNColorNTexture dom setBrushName Availability Fireworks 3 Usage dom setBrushNam...

Page 198: ...e of the texture to be applied Returns Nothing Description Sets the selection to the specified brush brush color and brush texture See also dom setBrushColor dom setBrushPlacement Availability Firewor...

Page 199: ...luded in the button If bIncludeDownState is false it is not Returns Nothing Description If the user edits a Button document this function specifies whether to include the Down state in a button dom se...

Page 200: ...age Arguments exportOptions An ExportOptions object see ExportOptions object on page 46 URLString A string that specifies the URL for the button s altTagString and targetTagString Specify the text for...

Page 201: ...ush and fill color to the default dom setDefaultFillVector Availability Fireworks 3 Usage dom setDefaultFillVector Arguments None Returns Nothing Description Sets the fill vector on the selection to t...

Page 202: ...angle are removed Returns Nothing Description Sets the document s canvas size to the specified rectangle Example The following command sets the canvas to a size of 200 by 200 pixels fw getDocumentDOM...

Page 203: ...Calculates the size of all the items in the selection and resizes the document canvas accordingly See also dom setDocumentCanvasSizeToDocumentExtents dom setDocumentImageSize Availability Fireworks 3...

Page 204: ...the document dom setEffectName Availability Fireworks MX Usage dom setEffectName category oldName newName Arguments category A string that defines the name of the category of the effect oldName The ex...

Page 205: ...s 4 Usage dom setElementMaskShowAttrs bShow Arguments bShow If bShow is true the vector mask fill and stroke are visible If false they are hidden Returns Nothing Description Specifies whether the curr...

Page 206: ...to show or hide all the elements in the specified layer pass 1 here bShow If bShow is true the element s are visible If bShow is false they are hidden Returns Nothing Description Shows or hides the s...

Page 207: ...ble dom setExportOptions Availability Fireworks 3 Usage dom setExportOptions exportOptions Arguments exportOptions An ExportOptions object see ExportOptions object on page 46 Returns Nothing Descripti...

Page 208: ...tring data type on page 11 Returns Nothing Description Changes the fill color of the selection to the specified color dom setFillEdgeMode Availability Fireworks 3 Usage dom setFillEdgeMode edgemode fe...

Page 209: ...ect on page 51 color A color string see Color string data type on page 11 texture name The name of the texture to be applied Returns Nothing Description Sets the selection to the specified fill fill c...

Page 210: ...works 3 Usage dom setFillVector p1 p2 p3 Arguments p1 p2 and p3 Points that specify the x y coordinates of the three points used to calculate the fill vector see Point data type on page 11 Returns Not...

Page 211: ...e A string that specifies the current name of the gradient newName A string that specifies the new name of the gradient Returns Nothing Description Renames a gradient dom setGridOrigin Availability Fi...

Page 212: ...color string see Color string data type on page 11 Returns Nothing Description Sets the color used to display the grid dom setGroupType Availability Fireworks 3 argument deprecated in 4 Usage dom setG...

Page 213: ...Color dom setHotspotAltTag Availability Fireworks 3 Usage dom setHotspotAltTag whatToSet altTagString Arguments whatToSet Acceptable values are hotspots slices and hotspots and slices altTagString A s...

Page 214: ...command sets the color of the selected Hotspots to red fw getDocumentDOM setHotspotColor hotspots ff0000 dom setHotspotRectangle Availability Fireworks 3 Usage dom setHotspotRectangle boundingRectang...

Page 215: ...m setHotspotTarget whatToSet targetTagString Arguments whatToSet targetTagString whatToSet Acceptable values are hotspots slices or hotspots and slices targetTagString A string that specifies the text...

Page 216: ...time http www mywebsite com was used it was used with a color of blue a target of none and an alt tag of Link to My Home Page If bUpdateAttributes is true any Hotspot or slice whose text is now being...

Page 217: ...ayer that is to be locked or unlocked starting with 0 although to specify the current frame pass 1 here bLock If bLock is true the layer is locked If bLock is false it is unlocked bAllLayers If bAllLa...

Page 218: ...document has multiple frames If these conditions are met and bUnshareCopiesToAllFrames is true the items on the layer are duplicated to all the frames of the layer if false the items are placed only...

Page 219: ...ers If bAllLayers is true all the layers on the specified frame are shown or hidden and any value that is passed for layerIndex is ignored Returns Nothing Description Shows or hides a layer on the spe...

Page 220: ...Returns Nothing Description If Fireworks is in bitmap mode this function sets the pixel selection mask of the current image to the specified mask See Also dom setSelectionMask dom setOnionSkinning Av...

Page 221: ...opRight pBottomRight pBottomLeft options Arguments pTopLeft pTopRight pBottomRight and pBottomLeft Points that specify the x y coordinates of the top left top right bottom right and bottom left points...

Page 222: ...he corners 0 is no roundness 1 is 100 roundness Returns Nothing Description Modifies the corner roundness of all the selected rectangle primitives See also dom addNewRectanglePrimitive dom setRectSide...

Page 223: ...e selection in a single operation dom setSelectionMask Availability Fireworks 4 Usage dom setSelectionMask mask howToCombineMasks Arguments mask Specifies the mask to be applied see Mask data type on...

Page 224: ...dges option is on or off dom setShowGammaPreview Availability Fireworks 3 Usage dom setShowGammaPreview bPreviewGamma Arguments bPreviewGamma If bPreviewGamma is true the Preview Gamma option is turne...

Page 225: ...f bShow is false they are not visible Returns Nothing Description Specifies whether normal guides are visible dom setShowRulers Availability Fireworks 3 Usage dom setShowRulers bShow Arguments bShow I...

Page 226: ...uments bShow If bShow is true the slice overlay is visible If bShow is false it is not visible Returns Nothing Description Specifies whether the slice overlay is visible dom setSliceAutonaming Availab...

Page 227: ...ame Availability Fireworks 3 Usage dom setSliceFilename fileURL Arguments fileURL A string which is expressed as a file URL that specifies the name to be given to the slice Returns Nothing Description...

Page 228: ...Text A string that specifies the HTML text for the slice Returns Nothing Description If a single slice is selected this function sets the slice s HTML text dom setSliceIsHtml Availability Fireworks 3...

Page 229: ...snap to guides dom setSymbolProperties Availability Fireworks 3 Usage dom setSymbolProperties currentName symbolType newName Arguments currentName Specifies the current name of the symbol in the libra...

Page 230: ...Returns Nothing Description Sets the alignment of the selected text items dom setTextAntiAliasing Availability Fireworks 3 Usage dom setTextAntiAliasing level Arguments level Acceptable values are cri...

Page 231: ...oint percentage of the default space to add to positive values or remove from negative values two adjacent characters To increase the spacing by 15 for example pass 0 15 Returns Nothing Description Ad...

Page 232: ...text in custom mode dom setTextCustomAntiAliasStrength Availability Fireworks MX 2004 Usage dom setTextCustomAntiAliasStrength strength Arguments Strength An integer value from 0 to 255 for the amoun...

Page 233: ...retches or compresses the height of the characters dom setTextLeading Availability Fireworks MX Usage dom setTextLeading leadingValue leadingMode Arguments leadingValue A floating point number that de...

Page 234: ...setTextOnPathOffset Availability Fireworks 3 Usage dom setTextOnPathOffset offset Arguments offset A floating point value that specifies the offset distance in pixels Returns Nothing Description Sets...

Page 235: ...Nothing Description Sets the paragraph indention of text in pixels dom setTextParaSpacingAfter Availability Fireworks MX Usage dom setTextParaSpacingAfter paraSpaceAfter Arguments paraSpaceAfter The n...

Page 236: ...this function defines the vertical distance between paragraphs If you apply dom setTextParaSpacingAfter in one paragraph and dom setTextParaSpacingBefore in the second paragraph the space between the...

Page 237: ...ata type on page 11 Returns Nothing Description Changes the bounding rectangle of the selected text item to the specified size This function causes the text to reflow inside the new rectangle the text...

Page 238: ...op and left edges at anchorPoint and the text expands to the right Centered horizontal text is centered horizontally around anchorPoint and expands equally to the left and right Centered vertical text...

Page 239: ...brush color and current fill color This function has no effect on any selected items dom transformSelection Availability Fireworks 3 enhanced in 4 Usage dom transformSelection matrix options Argument...

Page 240: ...ted to frames Returns Nothing Description Tweens between the two selected instances dom undo Availability Fireworks 3 Usage dom undo Arguments None Returns Nothing Description Undoes the most recent s...

Page 241: ...ed linked symbols in the library not the document are updated Returns Nothing Description Updates the specified linked symbol dom ungroup Availability Fireworks 3 Usage dom ungroup Arguments None Retu...

Page 242: ...orFileURL Availability Fireworks 3 Usage fw browseForFileURL browseType title previewArea Arguments browseType Acceptable values are open select and save The first two values display an Open dialog bo...

Page 243: ...Description Displays a dialog box that lets a user select a particular directory fw browseHelp Availability Fireworks MX Usage fw browseHelp helpID Arguments helpID The index number of the help topic...

Page 244: ...mary or secondary browser fw chooseScriptTargetDialog Availability Fireworks 4 Usage fw chooseScriptTargetDialog formatlist Arguments formatlist A list of target documents for an operation Its use is...

Page 245: ...d to save changes to the document If bPromptToSaveChanges is false the user is not prompted and any changes to the document are discarded Returns Nothing Description Closes the specified document fw c...

Page 246: ...the document s height Both values are in pixels res Specifies the resolution for the scaled document see Resolution data type on page 12 backgroundColor A color string see Color string data type on pa...

Page 247: ...if you are running a JavaScript file fw dismissBatchDialogWhenDone Availability Fireworks 4 Usage fw dismissBatchDialogWhenDone autoClose Arguments autoClose A Boolean value If set to true the Batch...

Page 248: ...g a JavaScript file fw exportAndCopyHTMLCode Availability Fireworks MX Usage fw exportAndCopyHTMLCode document Arguments document A Document object for example fw documents 2 that specifies the docume...

Page 249: ...ment to the specified file as Macromedia Director images fw exportDocumentAs Availability Fireworks 3 Usage fw exportDocumentAs document fileURL exportOptions Arguments document A Document object for...

Page 250: ...rames panel Example The following command exports the frames in the current document to the C images directory fw exportFrames null file C images fw exportHtmlAndImages Availability Fireworks 4 Usage...

Page 251: ...site nav htm file C mysite images nav gif See also fw exportDocumentAs fw exportIllustrator Availability Fireworks MX Usage fw exportIllustrator document fileURL Arguments document A Document object f...

Page 252: ...names in the Layers panel The layers from the current frame are exported Example The following command exports the layers in the third open document to the C images directory fw exportLayers fw docum...

Page 253: ...extEditable 1 var kTextRender 2 var prevText fw getPref PsdExport_Text fw setPref PsdExport_Text kTextRender fw exportPSD null file C new folder test psd Put the prefs back fw setPref PsdExport_Warn10...

Page 254: ...om frame only used if SwfExportAllFrames is false var prevJpegQualit fw getPref SwfJpegQuality fw setPref SwfJpegQuality 85 JPEG quality var prevFrameRate fw getPref SwfFrameRate fw setPref SwfFrameRa...

Page 255: ...the search is completed or 1 if there are items in the document that remain to be searched Description Finds the next instance of the current search string and selects that section of the document To...

Page 256: ...ive document see Document object on page 13 fw getDocumentPath Availability Fireworks 3 Usage fw getDocumentPath document Arguments document A Document object for example fw documents 2 that specifies...

Page 257: ...FloaterPosition Availability Fireworks 3 Usage fw getFloaterPosition panelName Arguments panelName Acceptable values are find project log object info url effect history mixer fill stroke swatches laye...

Page 258: ...extension For example the valid argument name for the Align panel Align swf is Align and a valid name for a custom panel file mypanel swf would be mypanel Returns A Boolean value true if the specified...

Page 259: ...ty Fireworks 3 Usage fw getPref prefkey Arguments prefkey A string that specifies the Preference value to return A complete list of these values is beyond the scope of this documentation but the forma...

Page 260: ...at is returned by fw findApp You can specify optionally files to open in the application See also fw findApp fw launchBrowserTo Availability Fireworks MX Usage fw launchBrowserTo url Arguments url The...

Page 261: ...fileURl A string or an array of strings each expressed as a file URL that specifies the files to be opened This argument is optional If fileURL is omitted or null the Open Document dialog box appears...

Page 262: ...ally selected color in the dialog box in the form rrggbbaa see Color string data type on page 11 for syntax details allowTransparent A Boolean value that lets the user select a transparent color set t...

Page 263: ...etails see Color string data type on page 11 Description Opens the color pop up window at the current mouse location to let the user select a color fw quit Availability Fireworks 4 Usage fw quit Argum...

Page 264: ...the table data Description Reads the specified table The tables are zero indexed fw readPanelStateFromFile Availability Fireworks MX Usage fw readPanelStateFromFile filepath Arguments filepath The lo...

Page 265: ...ge fw replaceAll Arguments None Returns The number of items replaced or 1 if the search is not yet complete Description Performs a replace all operation on the active document using the current search...

Page 266: ...is assumed to be the name of a file in the Fireworks MX Configuration Commands folder Returns Result of script Description Executes a JavaScript file Example The following command runs a script found...

Page 267: ...document as a native Fireworks PNG file with the specified name To save a document to another format such as GIF or JPEG use fw exportDocumentAs See also fw exportDocumentAs fw saveDocumentAs Availabi...

Page 268: ...box was canceled Description Saves a copy of the specified document as a native Fireworks PNG file with the specified name To save a document to another format such as GIF or JPEG use fw exportDocume...

Page 269: ...Nothing Description Sets the zoom amount and the center of the view for the current document fw setActiveWindow Availability Fireworks 3 Usage fw setActiveWindow document trueFalse Arguments document...

Page 270: ...arguments like those in the Command Panels folder which are outside the Fireworks application should be named exactly as they appear in the file system without their file extension For example the val...

Page 271: ...rner of the panel at the upper left of the specified rectangle Returns Nothing Description Sets the position and size of a panel fw setFloaterVisibility Availability Fireworks 3 Usage fw setFloaterVis...

Page 272: ...fw setPref prefname prefval Arguments prefname and prefval A complete list of these values is beyond the scope of this documentation but the format of prefname and prefval exactly matches those in th...

Page 273: ...ich are outside the Fireworks application should be named exactly as they appear in the file system without their file extension For example the valid argument name for the Align panel Align swf is Al...

Page 274: ...he Update HTML dialog box pass null for htmlUrl If you pass null for htmlUrl bRecoverFromError is ignored bRecoverFromError If bRecoverFromError is true and the HTML update encounters an error Firewor...

Page 275: ...Boolean value true if the user selected the Yes button false otherwise Description Displays a dialog box that contains buttons labeled Yes and No Example The following code displays a dialog box with...

Page 276: ...one Returns Nothing Description Makes the Property inspector window invisible fw isPIExpanded Availability Fireworks MX Usage fw isPIExpanded Arguments None Returns A Boolean value true if expanded fa...

Page 277: ...ty inspector window is currently hidden or shown fw growPIWindow Availability Fireworks MX Usage fw growPIWindow Arguments None Returns Nothing Description Expands the Property inspector window fw shr...

Page 278: ...ility Fireworks MX Usage fw getPIPosition Arguments None Returns A point object that is formatted as x float y float see Point data type on page 11 for syntax details which contains the location of th...

Page 279: ...ray that specifies which steps from the History panel should be copied If it is null the currently selected steps are used Returns Nothing Description Copies history steps to the Clipboard fw historyP...

Page 280: ...ilability Fireworks 3 Usage fw historyPalette getStepsAsJavaScript rray of indexes Arguments array of indexes A zero based array that specifies which steps from the History panel should be returned as...

Page 281: ...lso fw historyPalette setUndoState fw historyPalette replaySteps Availability Fireworks 3 Usage fw historyPalette replaySteps array of indexes Arguments array of indexes A zero based array that specif...

Page 282: ...ds folder with the specified filename Returns Nothing Description Gets the JavaScript equivalent of the specified steps and saves them as a JSF command file fw historyPalette setSelection Availability...

Page 283: ...s this API using app methodName The following methods are currently supported in Fireworks and Dreamweaver to let developers easily create commands for both applications app toggleFloater Identical to...

Page 284: ...284 Chapter 5 Fireworks JavaScript API...

Page 285: ...gleFloater 283 appendPointToHotspot 119 appendPointToPath 120 appendPointToSlice 120 applyCharacterMarkup 121 applyCurrentFill 121 applyEffects 122 applyFontMarkup 122 applyStyle 123 arguments optiona...

Page 286: ...r 137 deletePointOnPath 137 deleteSelection 138 deleteSymbol 138 deprecated functions or arguments dom clipPasteInside 130 dom getPixelMask 153 dom group 155 dom setAnimInstanceStartFrame 196 dom setG...

Page 287: ...ntiAliasing 145 dom enterElementMaskEditMode 146 dom enterPaintMode 146 dom exitElementMaskEditMode 147 dom exitPaintMode 147 dom exportOptions loadColorPalette 147 dom exportOptions saveColorPalette...

Page 288: ...91 dom sendEmail 192 dom setAllLayersDisclosure 193 dom setAnimInstanceLoopCount 193 dom setAnimInstanceNumFrames 193 dom setAnimInstanceOffsetDist 194 dom setAnimInstanceRotationAmount 194 dom setAni...

Page 289: ...ess 232 dom setTextCustomAntiAliasStrength 232 dom setTextFlow 232 dom setTextHorizontalScale 233 dom setTextLeading 233 dom setTextOnPathMode 234 dom setTextOnPathOffset 234 dom setTextOrientation 23...

Page 290: ...AndImages 250 exportIllustrator 251 exporting HTML and sliced images 64 exportLayers 251 ExportOptions object 46 48 exportOptions loadColorPalette 147 exportOptions saveColorPalette 148 ExportPaletteI...

Page 291: ...toryPalette getStepCount 280 fw historyPalette getStepsAsJavaScript 280 fw historyPalette getUndoState 280 fw historyPalette replaySteps 281 fw historyPalette saveAsCommand 281 fw historyPalette setSe...

Page 292: ...ects 64 Hue Effect object 36 Hue Saturation Effect object 36 I Image object 41 ImageMap object 68 69 ImagemapList object 69 importFile 156 importSymbol 157 importSymbolButNotAsAlias 157 index argument...

Page 293: ...alues 103 O object Behavior 26 BehaviorInfo 64 BehaviorsList 65 Brush 26 Contour 29 ContourNode 29 ContourNodeDynamicInfo 31 ControlPoint 31 Document 13 Effect 32 EffectList 38 Element 39 ElementMask...

Page 294: ...ll 179 removeFontMarkup 178 RemoveFromAutoReleasePool 87 removeGuide 179 removeTransformation 180 reorderFrame 180 reorderLayer 181 replace 264 replaceAll 265 replaceButtonTextStrings 181 replaceButto...

Page 295: ...4 setElementMaskShowAttrs 205 setElementName 205 setElementVisible 206 setElementVisibleByName 206 setExportOptions 207 setExportSettings 207 setFill 207 setFillColor 208 setFillEdgeMode 208 setFillNC...

Page 296: ...38 showAllHidden 238 showPIWindow 275 shrinkPIWindow 277 SingleTextRun object 59 sliced images 64 SliceHotspot object 42 SliceInfo object 69 Slices object 71 Slices htt 64 smartShape 80 smartShape obj...

Reviews:

No comments

Related manuals for DREAMWEAVER MX 2004-EXTENDING DREAMWEAVER

Brand: NAPCO Pages: 1

Brand: Acuma Labs Pages: 20

AUTOCAR CIVIL 2010

Brand: Autodesk Pages: 6

Brand: Primera Pages: 48

CLUSTER SUITE FOR ENTERPRISE LINUX 4.5

Brand: Red Hat Pages: 110

Brand: Cabletron Systems Pages: 92

IRISPowerscan 9.5

Brand: I.R.I.S. Pages: 182

CODESOFT Sentinel Print Pack

Brand: Techniques Avancees Pages: 50

Application Accelerator RAID Edition

Brand: Intel Pages: 85

Brand: Fiery Pages: 214

Brand: Dresser Pages: 57

Secure Backup 10.3

Brand: Oracle Pages: 174

Brand: FieldServer Pages: 15

Brand: Bay Networks Pages: 15

Brand: Valcom Pages: 8

POWER LEADER GEH-6510

Brand: GE Pages: 92

MOTOwi4 - RFS7000 - Network Management Device

Brand: Motorola Pages: 2

CDMA CONNECTIVITY KIT

Brand: Motorola Pages: 18

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands