Superdoc (library)

Categories:Flash

Overview

Summary

The Superdoc classis an attempt to reorganise the Document class into something more intuitive and manageable.

It does this by:

  • Structuring the methods and properties in a hierarchy
  • Converting getProperty() and setProperty() methods into getters and setters

More often than not, the Superdoc path is more verbose than the Document path, but if you're browsing for properties, it can help make your code clearer.

Usage

Superdoc is a library class, so you'll access properties on it without first instantating an instance. In conjunction with Komodo's code intelligence, you should be able to get to the property you need fairly quickly:

The following example breaks apart the current selection:

Superdoc.selection.edit.breakApart(); // fl.getDocumentDOM().breakApart();

The following example gets the current timeline:

Superdoc.containers.timeline.get(); // fl.getDocumentDOM().getTimeline();

The following example gets the document AS3 Document class:

Superdoc.settings.as3.docClass; // fl.getDocumentDOM().docClass;

The following example get the current document path:

Superdoc.file.properties.path; // fl.getDocumentDOM().path;

Documentation

At this time, Superdoc is not fully documented, but it is fully commented. These comments should display when you start typing in Komodo. If you need more information, CTRL+click the keywords to hyperlink to the source code.

API

appearance

fill	
	color
	toolbar
	selection
	swapWithStroke
stroke	
	color
	custom
	size
	style
	set
	swapWithFill
properties	
	width
	height
	size
	frameRate
	backgroundColor
	id
view	
	livePreview
	matrix
	vanishingPoint
	viewAngle
	zoom

containers

timeline	
	all
	current
	edit
	exit
	get
scene	
	add
	remove
	duplicate
	edit
	rename
	reorder
screens	
	allow
	outline
panel	
	library
	xml

data

set
get
meta	

elements

accessibility	
	autoLabel
	description
	forceSimple
	name
	silent
add	
	item
	line
	oval
	primitiveOval
	primitiveRectangle
	rectangle
	text
filter	
	add
	remove
	setProperty
	changeOrder
	enable
	disable
	disableOther
filters	
	set
	get
	remove
	disable
	enable
properties	
	alpha
	blendMode
	brightness
	property
	resetTransform
	tint
	unlock
text	
	attributes
	rectangle
	selection
	string

file

properties	
	name
	path
	uri
operations	
	close
	revert
	revertToLastVersion
	save
	saveAndCompact
	saveAVersion
	synchronizeWithHeadVersion
imports	
	file
	swf
exports	
	png
	swf
can	
	revert
	saveAVersion
	testMovie
	testScene
test	
	movie
	scene
publish

operations

clipboard	
	copy
	cut
	paste
mouse	
	click
	dblClk
tools	
	resetOval
	resetRectangle
	setOvalProperty
	setRectangleProperty

selection

elements
arrange	
	align
	arrange
	distribute
	match
	space
	toDocument
data	
edit	
	breakApart
	canEditSymbol
	convertLinesToFills
	convertToSymbol
	remove
	distributeToLayers
	duplicate
	enter
	exit
	group
	swapElement
	traceBitmap
	unGroup
select	
	all
	none
transform	
	bounds
	center
	moveBy
	rect
	rotate
	scale
	skew
	transform
transform3D	
	rotate
	translateCenter
	translate

settings

as3	
	autoDeclare
	dialect
	docClass
	exportFrame
	externalLibraryPath
	libraryPath
	sourcePath
	strictMode
	version
	warningsMode
mobile	
playerVersion	
publishProfile	
	current
	all
	add
	remove
	rename
	duplicate
	import
	importString
	export
	exportString

shapes

outlines	
	moveSelectedPointsBy
	optimize
	smooth
	straighten
operations	
	crop
	deleteEnvelope
	intersect
	punch
	union

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>