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

Adobe 38039927 Extended User Guide - Page 238

Frame object, FrameNLayerInter object

UPC - 883919091389

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

Page 238 highlights

ADOBE FIREWORKS CS3 234 Extending Guide Property shape Data type string stampingMode textureBlend webDitherTransparent string float Boolean Notes Acceptable values are "solid", "linear", "radial", "conical", "satin", "pinch", "folds", "elliptical", "rectangular", "bars", "ripple", "waves", "pattern", and "web dither". Acceptable values are "blend" and "blend opaque". 0 to 100 If set to true (and shape is set to "web dither"), then the second color in the ditherColors array is ignored and transparent is used instead. Frame object The following table lists the properties of the Frame object, along with their data types and, where appropriate, acceptable values and notes. Read-only properties are marked with a bullet (•). Property delay disposal layers • topLayers visible Data type integer string array array Boolean Notes Hundredths of a second. Acceptable values are "unspecified", "none", "background", and "previous". Array of FrameNLayerIntersection objects in the document (see "FrameNLayerIntersection object" on page 234). Array of top layers returned as FrameNLayerIntersection objects. If set to false, this frame is hidden. Default value is true. FrameNLayerIntersection object The following table lists the properties of the FrameNLayerIntersection object, along with their data types and, where appropriate, acceptable values and notes. Read-only properties are marked with a bullet (•). Property elements • Data type array Notes Array of Element objects (see "Element object" on page 221).

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

Match case Limit results 1 per page

ADOBE FIREWORKS CS3

Extending Guide

234

Frame object

The following table lists the properties of the Frame object, along with their data types and, where appropriate,

acceptable values and notes. Read-only properties are marked with a bullet (•).

FrameNLayerIntersection object

The following table lists the properties of the FrameNLayerIntersection object, along with their data types and,

where appropriate, acceptable values and notes. Read-only properties are marked with a bullet (•).

shape

string

Acceptable values are

"solid"

"linear"

"radial"

"conical"

"satin"

"pinch"

"folds"

"elliptical"

"rectangular"

"bars"

"ripple"

"waves"

"pattern"

and

"web dither"

stampingMode

string

Acceptable values are

"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

dither-

Colors

array is ignored and transparent is used

instead.

Property

Data type

Notes

delay

integer

Hundredths of a second.

disposal

string

Acceptable values are

"unspecified"

"none"

"background"

, and

"previous"

layers •

array

Array of FrameNLayerIntersection objects in the

document (see

“FrameNLayerIntersection object” on

page 234

topLayers

array

Array of top layers returned as FrameNLayerIntersec-

tion objects.

visible

Boolean

If set to

false

, this frame is hidden. Default value is

true

Property

Data type

Notes

elements •

array

Array of Element objects (see “Element object” on

page 221).

Property

Data type

Notes