Class Sprout::ADLTask
In: bundles/as3/lib/sprout/tasks/adl_documentation.rb
bundles/as3/lib/sprout/tasks/adl_task.rb
Parent: ToolTask

The ADL Task provides Rake support for the adl, Adobe Debug Launcher command. livedocs.adobe.com/flex/3/html/help.html?content=CommandLineTools_4.html#1031914

The following example can be pasted in a file named ‘rakefile.rb’:

  # Create an ADL task named :run dependent upon the swf that it is using for the window content
  adl :run => 'SomeProject.swf' do |t|
    t.root_directory = model.project_path
    t.application_descriptor = "#{model.src_dir}/TestProj-app.xml"
  end

Methods

Public Instance methods

The application descriptor file.

[Source]

# File bundles/as3/lib/sprout/tasks/adl_documentation.rb, line 37
def application_descriptor=(file)
  @application_descriptor = file
end

Passed to the application as command-line arguments.

[Source]

# File bundles/as3/lib/sprout/tasks/adl_documentation.rb, line 49
def arguments=(string)
  @arguments = string
end

[Source]

# File bundles/as3/lib/sprout/tasks/adl_task.rb, line 16
    def initialize_task
      super
      @default_gem_name = 'sprout-flex3sdk-tool'
      @default_gem_path = 'bin/adl'

      add_param(:runtime, :file) do |p|
        p.delimiter = " "
        p.description = "Specifies the directory containing the runtime to use. If not\nspecified, the runtime directory in the same SDK as the ADL program\nwill be used. If you move ADL out of its SDK folder, then you must\nspecify the runtime directory. On Windows, specify the directory\ncontaining the Adobe AIR directory. On Mac OSX, specify the directory\ncontaining Adobe AIR.framework.\n"
      end

      add_param(:nodebug, :boolean) do |p|
        p.hidden_value = true
        p.description = "Turns off debugging support. If used, the application process cannot\nconnect to the Flash debugger and dialogs for unhandled exceptions are\nsuppressed.\n\nTrace statements still print to the console window. Turning off\ndebugging allows your application to run a little faster and also\nemulates the execution mode of an installed application more closely.\n"
      end
      
      add_param(:pubid, :string) do |p|
        p.delimiter = " "
        p.description = "Assigns the specified value as the publisher ID of the AIR application\nfor this run. Specifying a temporary publisher ID allows you to test\nfeatures of an AIR application, such as communicating over a local\nconnection, that use the publisher ID to help uniquely identify an\napplication.\n\nThe final publisher ID is determined by the digital certificate used to\nsign the AIR installation file.\n"
      end

      add_param(:application_descriptor, :file) do |p|
        p.hidden_name = true
        p.required = true
        p.description = "The application descriptor file."
      end
      
      add_param(:root_directory, :file) do |p|
        p.hidden_name = true
        p.required = true
        p.description = "The root directory of the application to run. If not\nspecified, the directory containing the application\ndescriptor file is used.\n"
      end
      
      add_param(:arguments, :string) do |p|
        p.shell_name = "--"
        p.delimiter = " "
        p.description = "Passed to the application as command-line arguments.\n"
      end
            
    end

Turns off debugging support. If used, the application process cannot connect to the Flash debugger and dialogs for unhandled exceptions are suppressed.

Trace statements still print to the console window. Turning off debugging allows your application to run a little faster and also emulates the execution mode of an installed application more closely.

[Source]

# File bundles/as3/lib/sprout/tasks/adl_documentation.rb, line 20
def nodebug=(boolean)
  @nodebug = boolean
end

Assigns the specified value as the publisher ID of the AIR application for this run. Specifying a temporary publisher ID allows you to test features of an AIR application, such as communicating over a local connection, that use the publisher ID to help uniquely identify an application.

The final publisher ID is determined by the digital certificate used to sign the AIR installation file.

[Source]

# File bundles/as3/lib/sprout/tasks/adl_documentation.rb, line 32
def pubid=(string)
  @pubid = string
end

The root directory of the application to run. If not specified, the directory containing the application descriptor file is used.

[Source]

# File bundles/as3/lib/sprout/tasks/adl_documentation.rb, line 44
def root_directory=(file)
  @root_directory = file
end

Specifies the directory containing the runtime to use. If not specified, the runtime directory in the same SDK as the ADL program will be used. If you move ADL out of its SDK folder, then you must specify the runtime directory. On Windows, specify the directory containing the Adobe AIR directory. On Mac OSX, specify the directory containing Adobe AIR.framework.

[Source]

# File bundles/as3/lib/sprout/tasks/adl_documentation.rb, line 9
def runtime=(file)
  @runtime = file
end

[Validate]