Dmg (SetupBuilder 7.2.18 API)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - com.inet.gradle.setup.abstracts.AbstractTask
    - - com.inet.gradle.setup.abstracts.AbstractSetupTask
      - com.inet.gradle.setup.abstracts.AbstractUnixSetupTask
        
        com.inet.gradle.setup.dmg.Dmg

All Implemented Interfaces:

SetupSources, java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.file.ContentFilterable, org.gradle.api.file.CopyProcessingSpec, org.gradle.api.file.CopySourceSpec, org.gradle.api.file.CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>
```
public class Dmg
extends AbstractUnixSetupTask
```
The dmg Gradle task. It build a dmg package for Mac.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.gradle.api.Task
  org.gradle.api.Task.Namer

Field Summary
- Fields inherited from interface org.gradle.api.Task
  TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors
Constructor and Description

Dmg()
Create the task.

Constructors
Constructor and Description
`Dmg()` Create the task.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`build()` The platform depending build.
`void`	`conclusionPage(java.lang.Object conclusionPage)` Set the welcome page Allowed Format: rtf, rtfd, txt, html
`java.lang.String`	`getApplicationIdentifier(SetupBuilder setup)` Returns an application identifier set for the DMG builder.
`java.util.List<java.lang.String>`	`getArchitecture()` Get a list of supported architectures that will be added to the Info.plist file
`java.lang.String`	`getBackgroundColor()` Returns the converted background color as apple script string
`java.io.File`	`getBackgroundImage()` Return background Image for Finder View
`OSXCodeSign<Dmg,SetupBuilder>`	`getCodeSign()` Get the SignTool configuration if set
`java.util.List<LocalizedResource>`	`getConclusionPages()` Return the welcome page list Allowed Format: rtf, rtfd, txt, html
`int`	`getFontSize()` Return font size for Finder View
`int`	`getIconSize()` Return size of icons in Finder view
`java.util.List<java.lang.String>`	`getJreExcludes()` Get a list of string - defining files - that should be excluded from the bundled JRE
`java.util.List<java.lang.String>`	`getJreIncludes()` Get a list of string - defining files - that should be included in the bundled JRE
`java.util.List<org.apache.tools.ant.types.FileSet>`	`getNativeLibraries()` Returns the list of native libraries set for the current project
`java.util.List<PreferencesLink>`	`getPreferencesLinks()` Return the list of preferences links
`java.io.File`	`getSetupBackgroundImage()` Return the background image for the setup
`java.io.File`	`getSetupDarkBackgroundImage()` Returns a dark background image for the package installer
`java.lang.Object`	`getSetupIcon()` Returns the setup icon
`java.util.List<LocalizedResource>`	`getWelcomePages()` Return the welcome page list Allowed Format: rtf, rtfd, txt, html
`int`	`getWindowHeight()` Return height of Finder view INCLUDING the correction settings
`int`	`getWindowHeightCorrection()` Return correction height of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
`int`	`getWindowWidth()` Return width of Finder view INCLUDING the correction settings
`int`	`getWindowWidthCorrection()` Return correction width of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
`boolean`	`isAquaSystemAppearanceRequired()` Returns true, if the application requires the aqua system appearance.
`void`	`nativeLibraries(java.lang.Object library)` add a native library using any gradle compatible file syntax
`void`	`preferencesLink(org.gradle.api.Action<? super PreferencesLink> action)` Set a preferences link
`void`	`setApplicationIdentifier(java.lang.String applicationIdentifier)` Sets an application identifier for the DMG builder.
`void`	`setAquaSystemAppearanceRequired(boolean aquaSystemAppearanceRequired)` Define, that the application requires the system appearance.
`void`	`setArchitecture(java.util.List<java.lang.String> architecture)` Create a list of architectures from the given input list of strings.
`void`	`setBackgroundColor(java.awt.Color backgroundColor)`
`void`	`setBackgroundImage(java.io.File backgroundFile)` Set background Image for Finder View
`void`	`setCodeSign(org.gradle.api.Action<? super OSXCodeSign<? super Dmg,? super SetupBuilder>> action)` Set the needed information for signing the setup.
`void`	`setCodeSign(groovy.lang.Closure<OSXCodeSign<Dmg,SetupBuilder>> closure)` Set the needed information for signing the setup.
`void`	`setFontSize(int fontSize)` Set font size for Finder View
`void`	`setIconSize(int iconSize)` Set size of icons in Finder view
`void`	`setJreExcludes(java.util.List<java.lang.String> jreExclude)` Set a list of string - defining files - that should be excluded from the bundled JRE
`void`	`setJreIncludes(java.util.List<java.lang.String> jreIncludes)` Set a list of string - defining files - that should be included in the bundled JRE
`void`	`setSetupBackgroundImage(java.lang.Object setupBackground)` Set the background image for the setup
`void`	`setSetupDarkBackgroundImage(java.lang.Object setupDarkBackground)` Set the dark background image for the package installer
`void`	`setSetupIcon(java.lang.Object setupIcon)` Set up the setup icon
`void`	`setWindowHeight(int windowHeight)` Set height of Finder view
`void`	`setWindowHeightCorrection(int windowHeightCorrection)` Set correction height of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
`void`	`setWindowWidth(int windowWidth)` Set width of Finder view
`void`	`setWindowWidthCorrection(int windowWidthCorrection)` Set correction width of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
`void`	`welcomePage(java.lang.Object welcomePage)` Set the welcome page Allowed Format: rtf, rtfd, txt, html

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractUnixSetupTask
getDaemonUser, isUseInitD, setDaemonUser, setUseInitD

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractSetupTask
getPostinst, getPostrm, getPreinst, getPrerm, getSetupBuilder, setPostinst, setPostrm, setPreinst, setPrerm

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractTask
action, copyTo, getAbstractSetupBuilder, getClassifier, getDescription, getDocumentationRegistry, getExtension, getFileLookup, getFileResolver, getFileSystem, getInstantiator, getObjectFactory, getRootSpec, getSetupFile, getSetupSource, getSource, getVersion, processFiles, setClassifier, setExtension, setVersion

Methods inherited from class org.gradle.api.DefaultTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask
appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inet.gradle.setup.abstracts.SetupSources
eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirMode, getDuplicatesStrategy, getExcludes, getFileMode, getFilteringCharset, getIncludeEmptyDirs, getIncludes, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

Methods inherited from interface org.gradle.api.Task
getConvention

- Constructor Detail
  - Dmg
```
public Dmg()
```
    Create the task.
- Method Detail
  - build
```
public void build()
```
    The platform depending build.
    
    Specified by:
    
    build in class AbstractTask
  - getWindowWidth
```
@Input
public int getWindowWidth()
```
    Return width of Finder view INCLUDING the correction settings
    
    Returns:
    
    width of Finder view
  - setWindowWidth
```
public void setWindowWidth(int windowWidth)
```
    Set width of Finder view
    
    Parameters:
    
    windowWidth - width of Finder view
  - getWindowWidthCorrection
```
@Input
public int getWindowWidthCorrection()
```
    Return correction width of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
    
    Returns:
    
    width correction of Finder view
  - setWindowWidthCorrection
```
public void setWindowWidthCorrection(int windowWidthCorrection)
```
    Set correction width of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
    
    Parameters:
    
    windowWidthCorrection - width of Finder view
  - getWindowHeight
```
@Input
public int getWindowHeight()
```
    Return height of Finder view INCLUDING the correction settings
    
    Returns:
    
    height of Finder view
  - setWindowHeight
```
public void setWindowHeight(int windowHeight)
```
    Set height of Finder view
    
    Parameters:
    
    windowHeight - of Finder view
  - getWindowHeightCorrection
```
@Input
public int getWindowHeightCorrection()
```
    Return correction height of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
    
    Returns:
    
    width correction of Finder view
  - setWindowHeightCorrection
```
public void setWindowHeightCorrection(int windowHeightCorrection)
```
    Set correction height of Finder view This may be needed if there is a background-image set which does not take the borders of the window into account
    
    Parameters:
    
    windowHeightCorrection - height of Finder view
  - getIconSize
```
@Input
public int getIconSize()
```
    Return size of icons in Finder view
    
    Returns:
    
    size of icons in Finder view
  - setIconSize
```
public void setIconSize(int iconSize)
```
    Set size of icons in Finder view
    
    Parameters:
    
    iconSize - of icons in Finder view
  - getBackgroundImage
```
@InputFile
 @Optional
public java.io.File getBackgroundImage()
```
    Return background Image for Finder View
    
    Returns:
    
    background Image for Finder View
  - setBackgroundImage
```
public void setBackgroundImage(java.io.File backgroundFile)
```
    Set background Image for Finder View
    
    Parameters:
    
    backgroundFile - Image for Finder View
  - getFontSize
```
@Input
public int getFontSize()
```
    Return font size for Finder View
    
    Returns:
    
    font size for Finder View
  - setFontSize
```
public void setFontSize(int fontSize)
```
    Set font size for Finder View
    
    Parameters:
    
    fontSize - size for Finder View
  - setCodeSign
```
public void setCodeSign(groovy.lang.Closure<OSXCodeSign<Dmg,SetupBuilder>> closure)
```
    Set the needed information for signing the setup.
    
    Parameters:
    
    closure - the data for signing
  - setCodeSign
```
public void setCodeSign(org.gradle.api.Action<? super OSXCodeSign<? super Dmg,? super SetupBuilder>> action)
```
    Set the needed information for signing the setup.
    
    Parameters:
    
    action - the data for signing
  - getCodeSign
```
@Input
 @Optional
public OSXCodeSign<Dmg,SetupBuilder> getCodeSign()
```
    Get the SignTool configuration if set
    
    Returns:
    
    the settings or null
  - getConclusionPages
```
@Input
 @Optional
public java.util.List<LocalizedResource> getConclusionPages()
```
    Return the welcome page list Allowed Format: rtf, rtfd, txt, html
    
    Returns:
    
    welcome page
  - conclusionPage
```
public void conclusionPage(java.lang.Object conclusionPage)
```
    Set the welcome page Allowed Format: rtf, rtfd, txt, html
    
    Parameters:
    
    conclusionPage - which is shown at the end
  - getWelcomePages
```
@Input
 @Optional
public java.util.List<LocalizedResource> getWelcomePages()
```
    Return the welcome page list Allowed Format: rtf, rtfd, txt, html
    
    Returns:
    
    welcome page
  - welcomePage
```
public void welcomePage(java.lang.Object welcomePage)
```
    Set the welcome page Allowed Format: rtf, rtfd, txt, html
    
    Parameters:
    
    welcomePage - welcome page file
  - getSetupBackgroundImage
```
@InputFile
 @Optional
public java.io.File getSetupBackgroundImage()
```
    Return the background image for the setup
    
    Returns:
    
    background image
  - setSetupBackgroundImage
```
public void setSetupBackgroundImage(java.lang.Object setupBackground)
```
    Set the background image for the setup
    
    Parameters:
    
    setupBackground - to set
  - getSetupDarkBackgroundImage
```
@InputFile
 @Optional
public java.io.File getSetupDarkBackgroundImage()
```
    Returns a dark background image for the package installer
    
    Returns:
    
    a dark background image for the package installer
  - setSetupDarkBackgroundImage
```
public void setSetupDarkBackgroundImage(java.lang.Object setupDarkBackground)
```
    Set the dark background image for the package installer
    
    Parameters:
    
    setupDarkBackground - to set
  - getSetupIcon
```
@Input
 @Optional
public java.lang.Object getSetupIcon()
```
    Returns the setup icon
    
    Returns:
    
    the setupIcon
  - setSetupIcon
```
public void setSetupIcon(java.lang.Object setupIcon)
```
    Set up the setup icon
    
    Parameters:
    
    setupIcon - the setupIcon to set
  - getPreferencesLinks
```
@Input
 @Optional
public java.util.List<PreferencesLink> getPreferencesLinks()
```
    Return the list of preferences links
    
    Returns:
    
    preferences links
  - preferencesLink
```
public void preferencesLink(org.gradle.api.Action<? super PreferencesLink> action)
```
    Set a preferences link
    
    Parameters:
    
    action - the link
  - getJreIncludes
```
@Input
 @Optional
public java.util.List<java.lang.String> getJreIncludes()
```
    Get a list of string - defining files - that should be included in the bundled JRE
    
    Returns:
    
    the jreIncludes
  - setJreIncludes
```
public void setJreIncludes(java.util.List<java.lang.String> jreIncludes)
```
    Set a list of string - defining files - that should be included in the bundled JRE
    
    Parameters:
    
    jreIncludes - the jreIncludes to set
  - getJreExcludes
```
@Input
 @Optional
public java.util.List<java.lang.String> getJreExcludes()
```
    Get a list of string - defining files - that should be excluded from the bundled JRE
    
    Returns:
    
    the jreExclude
  - setJreExcludes
```
public void setJreExcludes(java.util.List<java.lang.String> jreExclude)
```
    Set a list of string - defining files - that should be excluded from the bundled JRE
    
    Parameters:
    
    jreExclude - the jreExclude to set
  - getArchitecture
```
@Input
 @Optional
public java.util.List<java.lang.String> getArchitecture()
```
    Get a list of supported architectures that will be added to the Info.plist file
    
    Returns:
    
    the list of architectures
  - setArchitecture
```
public void setArchitecture(java.util.List<java.lang.String> architecture)
```
    Create a list of architectures from the given input list of strings.
    
    Parameters:
    
    architecture - the list of supported architectures
  - getBackgroundColor
```
@Input
public java.lang.String getBackgroundColor()
```
    Returns the converted background color as apple script string
    
    Returns:
    
    the backgroundColor as dmgbuild color string
  - setBackgroundColor
```
public void setBackgroundColor(java.awt.Color backgroundColor)
```
    Parameters:
    
    backgroundColor - the backgroundColor to set
  - getApplicationIdentifier
```
public java.lang.String getApplicationIdentifier(SetupBuilder setup)
```
    Returns an application identifier set for the DMG builder. It is being used as ID in the Info.plist
    
    Parameters:
    
    setup - the SetupBuilder instance for a fallback
    
    Returns:
    
    the application identifier for macOS
  - setApplicationIdentifier
```
public void setApplicationIdentifier(java.lang.String applicationIdentifier)
```
    Sets an application identifier for the DMG builder. It is being used as ID in the Info.plist
    
    Parameters:
    
    applicationIdentifier - the application identifier for macOS
  - isAquaSystemAppearanceRequired
```
@Input
public boolean isAquaSystemAppearanceRequired()
```
    Returns true, if the application requires the aqua system appearance. False by default
    
    Returns:
    
    true, if the application requires the aqua system appearance.
  - setAquaSystemAppearanceRequired
```
public void setAquaSystemAppearanceRequired(boolean aquaSystemAppearanceRequired)
```
    Define, that the application requires the system appearance. False by default
    
    Parameters:
    
    aquaSystemAppearanceRequired - true, if the system appearance is required.
  - nativeLibraries
```
public void nativeLibraries(java.lang.Object library)
```
    add a native library using any gradle compatible file syntax
    
    Parameters:
    
    library - a native library to add
  - getNativeLibraries
```
@Input
public java.util.List<org.apache.tools.ant.types.FileSet> getNativeLibraries()
```
    Returns the list of native libraries set for the current project
    
    Returns:
    
    the list of native libraries set for the current project

Class Dmg

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Field Summary

Fields inherited from interface org.gradle.api.Task

Constructor Summary

Method Summary

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractUnixSetupTask

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractSetupTask

Methods inherited from class com.inet.gradle.setup.abstracts.AbstractTask

Methods inherited from class org.gradle.api.DefaultTask

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class java.lang.Object

Methods inherited from interface com.inet.gradle.setup.abstracts.SetupSources

Methods inherited from interface org.gradle.api.Task

Constructor Detail

Dmg

Method Detail

build

getWindowWidth

setWindowWidth

getWindowWidthCorrection

setWindowWidthCorrection

getWindowHeight

setWindowHeight

getWindowHeightCorrection

setWindowHeightCorrection

getIconSize

setIconSize

getBackgroundImage

setBackgroundImage

getFontSize

setFontSize

setCodeSign

setCodeSign

getCodeSign

getConclusionPages

conclusionPage

getWelcomePages

welcomePage

getSetupBackgroundImage

setSetupBackgroundImage

getSetupDarkBackgroundImage

setSetupDarkBackgroundImage

getSetupIcon

setSetupIcon

getPreferencesLinks

preferencesLink

getJreIncludes

setJreIncludes

getJreExcludes

setJreExcludes

getArchitecture

setArchitecture

getBackgroundColor

setBackgroundColor

getApplicationIdentifier

setApplicationIdentifier

isAquaSystemAppearanceRequired

setAquaSystemAppearanceRequired

nativeLibraries

getNativeLibraries