Slideshowpro for Flash Customization Guide
Total Page:16
File Type:pdf, Size:1020Kb
SlideShowPro for Flash Customization Guide (Version 1.8.x) Contents Introduction.......................................................................................................................................................................................3 Customization.basics....................................................................................................................................................................4 How.to:.SlideShowPro.for.Flash.Button.Packs..................................................................................................................5 How.to:.Custom.navigation.buttons...................................................................................................................................... 7 How.to:.Embed.SWF.in.a.separate.HTML.document.....................................................................................................9 How.to:.External.navigation.....................................................................................................................................................12 How.To:.Change.default.English.text....................................................................................................................................13 How.to:.Prevent.XML.caching................................................................................................................................................. 14 How.to:.Dynamically.assign.an.XML.file..............................................................................................................................15 How.to:.Load.XML.data.from.a.different.domain.......................................................................................................... 16 How.to:.Create.permalinks........................................................................................................................................................17 How.to:.Preload.SlideShowPro.for.Flash........................................................................................................................... 19 How.to:.Control.SlideShowPro.for.Flash.using.HTML/Javascript......................................................................... 20 Event.listeners................................................................................................................................................................................22 ActionScript.parameter.list.....................................................................................................................................................27 SlideShowPro for Flash Customization Guide Introduction This.SlideShowPro for Flash Customization Guide.was.written.for.intermediate.to. advanced.HTML/Flash.developers.(or.beginners.who.enjoy.getting.their.hands.dirty).. It.compliments.the.SlideShowPro for Flash User Guide.with.additional.information.to. trick.out.SlideShowPro.for.Flash.with.custom.elements.and.external.functionality. Before.diving.in,.read.the.“Customization.basics”.section.immediately.following.this. introduction..It.lays.the.groundwork.for.what.you’ll.need.to.know.in.order.to.use.the.rest.of.the. guide. If.you.run.into.trouble,.check.out.the.Troubleshooting.section.at.the.end,.or.visit.the.forums.at. http://slideshowpro.net/forums/.to.see.if.a.fellow.user.can.assist. Here.are.the.typographical.conventions.you.can.expect.so.see: Parameter name Indicates.parameter.names.that.are.assigned.to.SlideShowPro.in.Flash’s.Component. Inspector.panel..They.will.also.be.used.(sporadically).for.typographical.emphasis. Constant width Used.for.samples.of.XML,.JavaScript,.ActionScript,.and.other.code. Constant width italic A.placeholder.within.code.samples.that.should.be.substituted.with.your.own.value.. Have.fun! SlideShowPro for Flash Customization Guide Customization basics You.will.be.required.to.understand.a.few.basic.principles.of.Flash.in.order.to.use.this.guide..For. those.with.intermediate.to.advanced.knowledge.of.ActionScript,.you.can.probably.skip.this.section.. Everyone.else.should.continue.reading.before.moving.on. instance names When.using.ActionScript.you.must.first.assign. SlideShowPro.for.Flash.an.instance.name.. To.do.this,.select.the.copy.of.SlideShowPro. for.Flash.on.your.Stage,.open.the.Properties. panel.(Window.>.Properties),.type.a.short.but. memorable.title.into.the.text.field.shown.right.. Appending._ssp.onto.the.end.of.your.instance. Figure: Instance name in Properties panel name.is.recommended.for.it.will.activate.code. hints.in.the.Actions.panel,.and.make.your.code.easier.to.read. slideshowpro actionscript documentation To.view.all.of.SlideShowPro.for.Flash’s.properties,.events,. and.public.methods,.select.Help.>.Flash.Help.from.the. top.menu.in.Flash..Then.select.“All.Books”.from.the.pull- down.in.the.left.frame..Underneath.you.will.see.a.booklet. named.“SlideShowPro.for.Flash.”.Inside.are.three.folders:. “SlideShowPro.for.Flash.Properties,”.“SlideShowPro.for.Flash. Events,”.and.“SlideShowPro.for.Flash.Methods.”.Each.help. document.contains.definitions,.examples,.and.acceptable. parameters.you.can.use. Figure: Help panel actions panel The.Action.panel.(Window.>.Actions).is.where.you.enter. ActionScript.to.control.your.movie,.and.for.assigning.properties. to.SlideShowPro.for.Flash..For.example,.if.I.wanted.to.change. the.background.color.of.SlideShowPro.for.Flash.to.white,.I’d.first. create.a.new.timeline.layer.in.my.FLA.and.select.the.first.keyframe. of.that.layer..Then.in.the.Actions.panel.I’d.type.my.instance.name. assigned.earlier,.a.dot.(“.”).to.access.a.property,.the.property.name. I.want.to.change,.and.finally.a.value..Like.so: my_ssp.backgroundColor = "0xFFFFFF"; Figure: Actions panel SlideShowPro for Flash Customization Guide How to: SlideShowPro for Flash Button Packs SlideShowPro.for.Flash.Button.Packs.provide.users.with.an.extra.set.of.navigation.icons.to.replace. SlideShowPro.for.Flash’s.default.set..Each.pack.comes.with.two.icon.sizes.(24.pixels.square.and.16. pixels.square).for.each.navigation.icon,.and.are.designed.to.be.used.on.any.colored.background. Note:.SlideShowPro.Button.for.Flash.Packs.require.at.least.version.1.5.0.of.SlideShowPro.for.Flash.. Login.to.your.profile.at.http://slideshowpro.net.to.obtain.the.latest.version.if.necessary. purchase and download If.you.haven’t.already,.you.first.need.to.purchase.a.button.pack.from.http://slideshowpro.net..After. download,.double.click.on.the.ZIP.file.you.received.to.extract.a.folder.containing.your.icons. add icons to your fla Launch.Flash,.and.open.the.FLA.that.already.contains.SlideShowPro. for.Flash.(or.one.you.plan.on.adding.it.to)..From.the.“File”.menu,. select.“Import.>.Open.External.Library.”.Navigate.to.the.FLA.that’s. inside.the.button.pack.folder.you.just.unzipped,.select.it,.and.click.the. “Open”.button..A.new.Library.panel.will.appear.in.Flash.containing. two.icon.folders.(see.left)..One.contains.the.16.pixel.square.version. of.the.icon,.the.other.24.pixel.square..Drag.either.folder.from.the. Library.panel.to.the.Library.panel.of.your.open.FLA..The.icons.will. Figure: External Library transfer.to.your.FLA’s.Library. give slideshowpro for flash an instance name If.you.haven’t.done.so.already,.make.sure.that.SlideShowPro.for.Flash.is.on.the.stage.of.your.FLA.and. has.an.“instance.name”.so.it.can.be.referenced.with.ActionScript..See.the.“Customization.basics”.sec- tion.of.this.guide.for.instructions. actionscript Now.it’s.time.to.add.a.little.ActionScript!.In.the.folder.you.un- zipped.is.a.file.with.an.“.as”.file.extension..For.those.with.a.Profes- sional.version.of.Flash,.simply.double-click.on.this.file.to.open..If. you.receive.an.error.(that.your.OS.doesn’t.know.what.to.do.with. it),.open.the.file.in.any.text/html.editor,.like.Notepad,.Dreamweav- er,.TextMate,.etc..Once.open,.copy.to.your.clipboard.the.block.of. code.for.the.size.of.icon.you.plan.to.use. Return.to.your.FLA.in.Flash..Create.a.new.timeline.layer.by. Figure: New timeline layer with clicking.on.the.far.left.icon.at.the.bottom.of.the.timeline.window. first keyframe selected (it’ll.display.“Insert.Layer”.on.mouseover)..A.new.timeline. layer.will.appear..Click.on.the.first.empty.keyframe.in.this.new. layer,.then.open.the.Actions.panel..Click.inside.the.right.frame.of.the.editor.window,.and.paste.the. ActionScript.you.just.copied. SlideShowPro for Flash Customization Guide publish Publish.a.SWF.by.selecting.File.>.Publish.Preview.>.Flash.from.the.top.application.menu..If.all.goes.well,. your.icons.should.now.be.appearing.in.SlideShowPro.for.Flash! troubleshooting Don’t.see.the.buttons?.Here.are.a.couple.of.things.to.check. Instance name: Make.sure.you.gave.SlideShowPro.for.Flash.an.instance.name.of.“my_ssp”..If.you. are.already.using.a.different.instance.name,.replace.“my_ssp”.in.the.supplied.ActionScript.with.the. name.you.are.using. Timeline: The.ActionScript.you.pasted.must be.in.a.keyframe.directly.above.or.below.SlideShowPro. for.Flash..Not.before,.or.after..The.ActionScript.won’t.be.able.to.find.your.instance. video A.screencast.demonstrating.the.process.outlined.in.this.chapter.can.be.viewed.here: http://slideshowpro.net/help/screencasts/02_SSP_Button_Packs.php SlideShowPro for Flash Customization Guide How to: Custom navigation buttons SlideShowPro.for.Flash.allows.you.to.replace.its.default.navigational.buttons.with.your.own..This. chapter.will.show.you.how. create a movie clip The.first.step.is.to.create.a.new.MovieClip.in.your.FLA. Library..This.clip.will.contain.your.first.navigation.button.. To.do.this,.click.the.“Add.symbol”.button.in.the.bottom-