AutofitLimits

AutoFit limit values

Methods:

addEventListener, dimensions, exist, getElements, height, isActive, removeEventListener, resetAllToDefaults, set, toSource, toSpecifier, width

Hierarchy:

Superclass: Preference

Class: AutofitLimits

Property Listing

Property

Type

Access

Description

enabled

Boolean

read/write

Determine whether the limit checks of AutoFit are enabled ('true' by default)

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

maximumHeight

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The maximum height (always in points). Can return: Real or AutofitLimitType enumerator.

maximumLength

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The maximum length (always in points). Can return: Real or AutofitLimitType enumerator.

maximumWidth

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The maximum width (always in points). Can return: Real or AutofitLimitType enumerator.

minimumHeight

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The minimum height (always in points). Can return: Real or AutofitLimitType enumerator.

minimumLength

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The minimum length (always in points). Can return: Real or AutofitLimitType enumerator.

minimumWidth

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The minimum width (always in points). Can return: Real or AutofitLimitType enumerator.

parent

AutofitPageItemSettings

readonly

The parent of the AutofitLimits (a AutofitPageItemSettings).

properties

Object

read/write

A property that allows setting of several properties at the same time.

proportionalHeight

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The proportional height. Can return: Real or AutofitLimitType enumerator.

proportionalWidth

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

read/write

The proportional width. Can return: Real or AutofitLimitType enumerator.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

Number dimensions (scale:Array of Varies Real 2 Reals (>= 0). , set:Boolean)

Get/set the current dimensions in points, optionally scaled by a given factor.

Parameter

Type

Description

scale

Real

Array of 2 Reals (>= 0).

The optional scale factor > 0 (1.0 by default). Might be an array of two scale factors for width and height. Can accept: Real or Array of 2 Reals (>= 0). (Optional)

set

Boolean

Optionally use the method to set the minimum and maximum width and height to the computed values (Optional)

Boolean exist ()

Test whether the AutoFit specific data of AutofitLimits specifies relevant values at all

AutofitLimits getElements ()

Resolves the object specifier, creating an array of object references.

Number height (scale:Number, set:Boolean)

Get/set the current height in points, optionally scaled by a given factor.

Parameter

Type

Description

scale

Number

The optional scale factor > 0 (1.0 by default) (Optional)

set

Boolean

Optionally use the method to set the minimum and maximum height to the computed value (Optional)

Boolean isActive ()

Test whether AutofitLimits is active in terms of AutoFit

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

undefined resetAllToDefaults ()

Reset the AutoFit specific data of AutofitLimits to the default values

undefined set ([minimumWidth:Varies Real AutofitLimitType=Varies Real AutofitLimitType], [maximumWidth:Varies Real AutofitLimitType=Varies Real AutofitLimitType], [minimumHeight:Varies Real AutofitLimitType=Varies Real AutofitLimitType], [maximumHeight:Varies Real AutofitLimitType=Varies Real AutofitLimitType], [proportionalWidth:Varies Real AutofitLimitType=Varies Real AutofitLimitType], [proportionalHeight:Varies Real AutofitLimitType=Varies Real AutofitLimitType], [minimumLength:Varies Real AutofitLimitType=Varies Real AutofitLimitType], [maximumLength:Varies Real AutofitLimitType=Varies Real AutofitLimitType], enabled:Boolean)

Set the values related to AutoFit limits at once

Parameter

Type

Description

minimumWidth

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The minimum width. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

maximumWidth

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The maximum width. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

minimumHeight

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The minimum height. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

maximumHeight

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The maximum height. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

proportionalWidth

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The proportional width. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

proportionalHeight

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The proportional height. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

minimumLength

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The minimum length. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

maximumLength

Real

AutofitLimitType

AutofitLimitType.CURRENT_VALUE

AutofitLimitType.NO_LIMIT

The maximum length. Can accept: Real or AutofitLimitType enumerator. (Optional)

(default: AutofitLimitType.NO_LIMIT)

enabled

Boolean

Determine if limit checks of AutoFit are enabled (Optional)

String toSource ()

Generates a string which, if executed, will return the AutofitLimits.

String toSpecifier ()

Retrieves the object specifier.

Number width (scale:Number, set:Boolean)

Get/set the current width in points, optionally scaled by a given factor.

Parameter

Type

Description

scale

Number

The optional scale factor > 0 (1.0 by default) (Optional)

set

Boolean

Optionally use the method to set the minimum and maximum width to the computed value (Optional)

Object of

AutofitPageItemSettings.limits

Event.parent

EventListener.parent

MutationEvent.parent

Return

AutofitLimits.getElements()