Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7420107
ve.dm.Scalable.js
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
17 KB
Referenced Files
None
Subscribers
None
ve.dm.Scalable.js
View Options
/*!
* VisualEditor DataModel Scalable class.
*
* @copyright See AUTHORS.txt
*/
/**
* Scalable object.
*
* @class
* @mixes OO.EventEmitter
*
* @constructor
* @param {Object} [config] Configuration options
* @param {boolean} [config.fixedRatio=true] Object has a fixed aspect ratio
* @param {Object} [config.currentDimensions] Current dimensions, width & height
* @param {Object} [config.originalDimensions] Original dimensions, width & height
* @param {Object} [config.defaultDimensions] Default dimensions, width & height
* @param {boolean} [config.isDefault] Object is using its default dimensions
* @param {Object} [config.minDimensions] Minimum dimensions, width & height
* @param {Object} [config.maxDimensions] Maximum dimensions, width & height
* @param {boolean} [config.enforceMin=true] Enforce the minimum dimensions
* @param {boolean} [config.enforceMax=true] Enforce the maximum dimensions
*/
ve
.
dm
.
Scalable
=
function
VeDmScalable
(
config
)
{
config
=
ve
.
extendObject
(
{
fixedRatio
:
true
,
enforceMin
:
true
,
enforceMax
:
true
},
config
);
// Mixin constructors
OO
.
EventEmitter
.
call
(
this
);
// Computed properties
this
.
ratio
=
null
;
this
.
valid
=
null
;
this
.
defaultSize
=
false
;
// Initialize
this
.
currentDimensions
=
null
;
this
.
defaultDimensions
=
null
;
this
.
originalDimensions
=
null
;
this
.
minDimensions
=
null
;
this
.
maxDimensions
=
null
;
// Properties
this
.
fixedRatio
=
config
.
fixedRatio
;
if
(
config
.
currentDimensions
)
{
this
.
setCurrentDimensions
(
config
.
currentDimensions
);
}
if
(
config
.
originalDimensions
)
{
this
.
setOriginalDimensions
(
config
.
originalDimensions
);
}
if
(
config
.
defaultDimensions
)
{
this
.
setDefaultDimensions
(
config
.
defaultDimensions
);
}
if
(
config
.
isDefault
)
{
this
.
toggleDefault
(
!!
config
.
isDefault
);
}
if
(
config
.
minDimensions
)
{
this
.
setMinDimensions
(
config
.
minDimensions
);
}
if
(
config
.
maxDimensions
)
{
this
.
setMaxDimensions
(
config
.
maxDimensions
);
}
this
.
setEnforcedMin
(
config
.
enforceMin
);
this
.
setEnforcedMax
(
config
.
enforceMax
);
};
/* Inheritance */
OO
.
mixinClass
(
ve
.
dm
.
Scalable
,
OO
.
EventEmitter
);
/* Events */
/**
* Current changed
*
* @event ve.dm.Scalable#currentSizeChange
* @param {Object} currentDimensions Current dimensions width and height
*/
/**
* Default size or state changed
*
* @event ve.dm.Scalable#defaultSizeChange
* @param {boolean} isDefault The size is default
*/
/**
* Original size changed
*
* @event ve.dm.Scalable#originalSizeChange
* @param {Object} originalDimensions Original dimensions width and height
*/
/**
* Min size changed
*
* @event ve.dm.Scalable#minSizeChange
* @param {Object} minDimensions Min dimensions width and height
*/
/**
* Max size changed
*
* @event ve.dm.Scalable#maxSizeChange
* @param {Object} maxDimensions Max dimensions width and height
*/
/**
* Calculate the dimensions from a given value of either width or height.
* This method doesn't take into account any restrictions of minimum or maximum,
* it simply calculates the new dimensions according to the aspect ratio in case
* it exists.
*
* If aspect ratio does not exist, or if the original object is empty, or if the
* original object is fully specified, the object is returned as-is without
* calculations.
*
* @param {Object} dimensions Dimensions object with either width or height
* if both are given, the object will be returned as-is.
* @param {number} [dimensions.width] The width of the image
* @param {number} [dimensions.height] The height of the image
* @param {number} [ratio] The image width/height ratio, if it exists
* @return {Object} Dimensions object with width and height
*/
ve
.
dm
.
Scalable
.
static
.
getDimensionsFromValue
=
function
(
dimensions
,
ratio
)
{
dimensions
=
ve
.
copy
(
dimensions
);
// Normalize for 'empty' values that are specifically given
// so if '' is explicitly given, it should be translated to 0
if
(
dimensions
.
width
===
''
)
{
dimensions
.
width
=
0
;
}
if
(
dimensions
.
height
===
''
)
{
dimensions
.
height
=
0
;
}
// Calculate the opposite size if needed
if
(
!
dimensions
.
height
&&
ratio
!==
null
&&
+
dimensions
.
width
)
{
dimensions
.
height
=
Math
.
round
(
dimensions
.
width
/
ratio
);
}
if
(
!
dimensions
.
width
&&
ratio
!==
null
&&
+
dimensions
.
height
)
{
dimensions
.
width
=
Math
.
round
(
dimensions
.
height
*
ratio
);
}
return
dimensions
;
};
/**
* Check if an object is a dimensions object.
* Make sure that if width or height are set, they are not 'undefined'.
*
* @param {Object} dimensions A dimensions object to test
* @return {boolean} Valid or invalid dimensions object
*/
ve
.
dm
.
Scalable
.
static
.
isDimensionsObjectValid
=
function
(
dimensions
)
{
if
(
dimensions
&&
!
ve
.
isEmptyObject
(
dimensions
)
&&
(
dimensions
.
width
!==
undefined
||
dimensions
.
height
!==
undefined
)
)
{
return
true
;
}
return
false
;
};
/* Methods */
/**
* Clone the current scalable object
*
* @return {ve.dm.Scalable} Cloned scalable object
*/
ve
.
dm
.
Scalable
.
prototype
.
clone
=
function
()
{
const
currentDimensions
=
this
.
getCurrentDimensions
(),
originalDimensions
=
this
.
getOriginalDimensions
(),
defaultDimensions
=
this
.
getDefaultDimensions
(),
minDimensions
=
this
.
getMinDimensions
(),
maxDimensions
=
this
.
getMaxDimensions
(),
config
=
{
isDefault
:
!!
this
.
isDefault
(),
enforceMin
:
!!
this
.
isEnforcedMin
(),
enforceMax
:
!!
this
.
isEnforcedMax
()
};
if
(
currentDimensions
)
{
config
.
currentDimensions
=
ve
.
copy
(
currentDimensions
);
}
if
(
originalDimensions
)
{
config
.
originalDimensions
=
ve
.
copy
(
originalDimensions
);
}
if
(
defaultDimensions
)
{
config
.
defaultDimensions
=
ve
.
copy
(
defaultDimensions
);
}
if
(
minDimensions
)
{
config
.
minDimensions
=
ve
.
copy
(
minDimensions
);
}
if
(
maxDimensions
)
{
config
.
maxDimensions
=
ve
.
copy
(
maxDimensions
);
}
return
new
this
.
constructor
(
config
);
};
/**
* Set the fixed aspect ratio from specified dimensions.
*
* @param {Object} dimensions Dimensions object with width & height
*/
ve
.
dm
.
Scalable
.
prototype
.
setRatioFromDimensions
=
function
(
dimensions
)
{
if
(
dimensions
&&
dimensions
.
width
&&
dimensions
.
height
)
{
this
.
ratio
=
dimensions
.
width
/
dimensions
.
height
;
}
this
.
valid
=
null
;
};
/**
* Set the current dimensions
*
* Also sets the aspect ratio if not set and in fixed ratio mode.
*
* @param {Object} dimensions Dimensions object with width & height
* @fires ve.dm.Scalable#currentSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
setCurrentDimensions
=
function
(
dimensions
)
{
if
(
this
.
constructor
.
static
.
isDimensionsObjectValid
(
dimensions
)
&&
!
ve
.
compare
(
dimensions
,
this
.
getCurrentDimensions
()
)
)
{
this
.
currentDimensions
=
ve
.
copy
(
dimensions
);
// Only use current dimensions for ratio if it isn't set
if
(
this
.
fixedRatio
&&
!
this
.
ratio
)
{
this
.
setRatioFromDimensions
(
this
.
getCurrentDimensions
()
);
}
this
.
valid
=
null
;
this
.
emit
(
'currentSizeChange'
,
this
.
getCurrentDimensions
()
);
}
};
/**
* Set the original dimensions
*
* Also resets the aspect ratio if in fixed ratio mode.
*
* @param {Object} dimensions Dimensions object with width & height
* @fires ve.dm.Scalable#originalSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
setOriginalDimensions
=
function
(
dimensions
)
{
if
(
this
.
constructor
.
static
.
isDimensionsObjectValid
(
dimensions
)
&&
!
ve
.
compare
(
dimensions
,
this
.
getOriginalDimensions
()
)
)
{
this
.
originalDimensions
=
ve
.
copy
(
dimensions
);
// Always overwrite ratio
if
(
this
.
fixedRatio
)
{
this
.
setRatioFromDimensions
(
this
.
getOriginalDimensions
()
);
}
this
.
valid
=
null
;
this
.
emit
(
'originalSizeChange'
,
this
.
getOriginalDimensions
()
);
}
};
/**
* Set the default dimensions
*
* @param {Object} dimensions Dimensions object with width & height
* @fires ve.dm.Scalable#defaultSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
setDefaultDimensions
=
function
(
dimensions
)
{
if
(
this
.
constructor
.
static
.
isDimensionsObjectValid
(
dimensions
)
&&
!
ve
.
compare
(
dimensions
,
this
.
getDefaultDimensions
()
)
)
{
this
.
defaultDimensions
=
ve
.
copy
(
dimensions
);
this
.
valid
=
null
;
this
.
emit
(
'defaultSizeChange'
,
this
.
isDefault
()
);
}
};
/**
* Reset and remove the default dimensions
*
* @fires ve.dm.Scalable#defaultSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
clearDefaultDimensions
=
function
()
{
if
(
this
.
defaultDimensions
!==
null
)
{
this
.
defaultDimensions
=
null
;
this
.
valid
=
null
;
this
.
emit
(
'defaultSizeChange'
,
this
.
isDefault
()
);
}
};
/**
* Reset and remove the default dimensions
*
* @fires ve.dm.Scalable#originalSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
clearOriginalDimensions
=
function
()
{
if
(
this
.
originalDimensions
!==
null
)
{
this
.
originalDimensions
=
null
;
this
.
valid
=
null
;
this
.
emit
(
'originalSizeChange'
,
this
.
isDefault
()
);
}
};
/**
* Toggle the default size setting, or set it to particular value
*
* @param {boolean} [isDefault] Default or not, toggles if unset
* @fires ve.dm.Scalable#defaultSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
toggleDefault
=
function
(
isDefault
)
{
if
(
isDefault
===
undefined
)
{
isDefault
=
!
this
.
isDefault
();
}
if
(
this
.
isDefault
()
!==
isDefault
)
{
this
.
defaultSize
=
isDefault
;
if
(
isDefault
)
{
this
.
setCurrentDimensions
(
this
.
getDefaultDimensions
()
);
}
this
.
emit
(
'defaultSizeChange'
,
this
.
isDefault
()
);
}
};
/**
* Set the minimum dimensions
*
* @param {Object} dimensions Dimensions object with width & height
* @fires ve.dm.Scalable#minSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
setMinDimensions
=
function
(
dimensions
)
{
if
(
this
.
constructor
.
static
.
isDimensionsObjectValid
(
dimensions
)
&&
!
ve
.
compare
(
dimensions
,
this
.
getMinDimensions
()
)
)
{
this
.
minDimensions
=
ve
.
copy
(
dimensions
);
this
.
valid
=
null
;
this
.
emit
(
'minSizeChange'
,
dimensions
);
}
};
/**
* Set the maximum dimensions
*
* @param {Object} dimensions Dimensions object with width & height
* @fires ve.dm.Scalable#maxSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
setMaxDimensions
=
function
(
dimensions
)
{
if
(
this
.
constructor
.
static
.
isDimensionsObjectValid
(
dimensions
)
&&
!
ve
.
compare
(
dimensions
,
this
.
getMaxDimensions
()
)
)
{
this
.
maxDimensions
=
ve
.
copy
(
dimensions
);
this
.
emit
(
'maxSizeChange'
,
dimensions
);
this
.
valid
=
null
;
}
};
/**
* Clear the minimum dimensions
*
* @fires ve.dm.Scalable#minSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
clearMinDimensions
=
function
()
{
if
(
this
.
minDimensions
!==
null
)
{
this
.
minDimensions
=
null
;
this
.
valid
=
null
;
this
.
emit
(
'minSizeChange'
,
this
.
minDimensions
);
}
};
/**
* Clear the maximum dimensions
*
* @fires ve.dm.Scalable#maxSizeChange
*/
ve
.
dm
.
Scalable
.
prototype
.
clearMaxDimensions
=
function
()
{
if
(
this
.
maxDimensions
!==
null
)
{
this
.
maxDimensions
=
null
;
this
.
valid
=
null
;
this
.
emit
(
'maxSizeChange'
,
this
.
maxDimensions
);
}
};
/**
* Get the original dimensions
*
* @return {Object} Dimensions object with width & height
*/
ve
.
dm
.
Scalable
.
prototype
.
getCurrentDimensions
=
function
()
{
return
this
.
currentDimensions
;
};
/**
* Get the original dimensions
*
* @return {Object} Dimensions object with width & height
*/
ve
.
dm
.
Scalable
.
prototype
.
getOriginalDimensions
=
function
()
{
return
this
.
originalDimensions
;
};
/**
* Get the default dimensions
*
* @return {Object} Dimensions object with width & height
*/
ve
.
dm
.
Scalable
.
prototype
.
getDefaultDimensions
=
function
()
{
return
this
.
defaultDimensions
;
};
/**
* Get the default state of the scalable object
*
* @return {boolean} Default size or custom
*/
ve
.
dm
.
Scalable
.
prototype
.
isDefault
=
function
()
{
return
this
.
defaultSize
;
};
/**
* Get the minimum dimensions
*
* @return {Object} Dimensions object with width & height
*/
ve
.
dm
.
Scalable
.
prototype
.
getMinDimensions
=
function
()
{
return
this
.
minDimensions
;
};
/**
* Get the maximum dimensions
*
* @return {Object} Dimensions object with width & height
*/
ve
.
dm
.
Scalable
.
prototype
.
getMaxDimensions
=
function
()
{
return
this
.
maxDimensions
;
};
/**
* The object enforces the minimum dimensions when scaling
*
* @return {boolean} Enforces the minimum dimensions
*/
ve
.
dm
.
Scalable
.
prototype
.
isEnforcedMin
=
function
()
{
return
this
.
enforceMin
;
};
/**
* The object enforces the maximum dimensions when scaling
*
* @return {boolean} Enforces the maximum dimensions
*/
ve
.
dm
.
Scalable
.
prototype
.
isEnforcedMax
=
function
()
{
return
this
.
enforceMax
;
};
/**
* Set enforcement of minimum dimensions
*
* @param {boolean} enforceMin Enforces the minimum dimensions
*/
ve
.
dm
.
Scalable
.
prototype
.
setEnforcedMin
=
function
(
enforceMin
)
{
this
.
valid
=
null
;
this
.
enforceMin
=
!!
enforceMin
;
};
/**
* Set enforcement of maximum dimensions
*
* @param {boolean} enforceMax Enforces the maximum dimensions
*/
ve
.
dm
.
Scalable
.
prototype
.
setEnforcedMax
=
function
(
enforceMax
)
{
this
.
valid
=
null
;
this
.
enforceMax
=
!!
enforceMax
;
};
/**
* Get the fixed aspect ratio (width/height)
*
* @return {number} Aspect ratio
*/
ve
.
dm
.
Scalable
.
prototype
.
getRatio
=
function
()
{
return
this
.
ratio
;
};
/**
* Check if the object has a fixed ratio
*
* @return {boolean} The object has a fixed ratio
*/
ve
.
dm
.
Scalable
.
prototype
.
isFixedRatio
=
function
()
{
return
this
.
fixedRatio
;
};
/**
* Get the current scale of the object
*
* @return {number|null} A scale (1=100%), or null if not applicable
*/
ve
.
dm
.
Scalable
.
prototype
.
getCurrentScale
=
function
()
{
if
(
!
this
.
isFixedRatio
()
||
!
this
.
getCurrentDimensions
()
||
!
this
.
getOriginalDimensions
()
)
{
return
null
;
}
return
this
.
getCurrentDimensions
().
width
/
this
.
getOriginalDimensions
().
width
;
};
/**
* Check if current dimensions are smaller than minimum dimensions in either direction
*
* Only possible if enforceMin is false.
*
* @return {boolean} Current dimensions are greater than maximum dimensions
*/
ve
.
dm
.
Scalable
.
prototype
.
isTooSmall
=
function
()
{
return
!!
(
this
.
getCurrentDimensions
()
&&
this
.
getMinDimensions
()
&&
(
this
.
getCurrentDimensions
().
width
<
this
.
getMinDimensions
().
width
||
this
.
getCurrentDimensions
().
height
<
this
.
getMinDimensions
().
height
)
);
};
/**
* Check if current dimensions are greater than maximum dimensions in either direction
*
* Only possible if enforceMax is false.
*
* @return {boolean} Current dimensions are greater than maximum dimensions
*/
ve
.
dm
.
Scalable
.
prototype
.
isTooLarge
=
function
()
{
return
!!
(
this
.
getCurrentDimensions
()
&&
this
.
getMaxDimensions
()
&&
(
this
.
getCurrentDimensions
().
width
>
this
.
getMaxDimensions
().
width
||
this
.
getCurrentDimensions
().
height
>
this
.
getMaxDimensions
().
height
)
);
};
/**
* Get a set of dimensions bounded by current restrictions, from specified dimensions
*
* @param {Object} dimensions Dimensions object with width & height
* @param {number} [grid] Optional grid size to snap to
* @return {Object} Dimensions object with width & height
*/
ve
.
dm
.
Scalable
.
prototype
.
getBoundedDimensions
=
function
(
dimensions
,
grid
)
{
const
minDimensions
=
this
.
isEnforcedMin
()
&&
this
.
getMinDimensions
(),
maxDimensions
=
this
.
isEnforcedMax
()
&&
this
.
getMaxDimensions
();
dimensions
=
ve
.
copy
(
dimensions
);
// Bound to min/max
if
(
minDimensions
)
{
dimensions
.
width
=
Math
.
max
(
dimensions
.
width
,
this
.
minDimensions
.
width
);
dimensions
.
height
=
Math
.
max
(
dimensions
.
height
,
this
.
minDimensions
.
height
);
}
if
(
maxDimensions
)
{
dimensions
.
width
=
Math
.
min
(
dimensions
.
width
,
this
.
maxDimensions
.
width
);
dimensions
.
height
=
Math
.
min
(
dimensions
.
height
,
this
.
maxDimensions
.
height
);
}
// Bound to ratio
if
(
this
.
isFixedRatio
()
)
{
const
ratio
=
dimensions
.
width
/
dimensions
.
height
;
if
(
ratio
<
this
.
getRatio
()
)
{
dimensions
.
height
=
Math
.
round
(
dimensions
.
width
/
this
.
getRatio
()
);
}
else
{
dimensions
.
width
=
Math
.
round
(
dimensions
.
height
*
this
.
getRatio
()
);
}
}
// Snap to grid
if
(
grid
)
{
let
snapMin
=
minDimensions
?
Math
.
ceil
(
minDimensions
.
width
/
grid
)
:
-
Infinity
;
let
snapMax
=
maxDimensions
?
Math
.
floor
(
maxDimensions
.
width
/
grid
)
:
Infinity
;
let
snap
=
Math
.
round
(
dimensions
.
width
/
grid
);
dimensions
.
width
=
Math
.
max
(
Math
.
min
(
snap
,
snapMax
),
snapMin
)
*
grid
;
if
(
this
.
isFixedRatio
()
)
{
// If the ratio is fixed we can't snap both to the grid, so just snap the width
dimensions
.
height
=
Math
.
round
(
dimensions
.
width
/
this
.
getRatio
()
);
}
else
{
snapMin
=
minDimensions
?
Math
.
ceil
(
minDimensions
.
height
/
grid
)
:
-
Infinity
;
snapMax
=
maxDimensions
?
Math
.
floor
(
maxDimensions
.
height
/
grid
)
:
Infinity
;
snap
=
Math
.
round
(
dimensions
.
height
/
grid
);
dimensions
.
height
=
Math
.
max
(
Math
.
min
(
snap
,
snapMax
),
snapMin
)
*
grid
;
}
}
return
dimensions
;
};
/**
* Checks whether the current dimensions are numeric and within range
*
* @return {boolean} Current dimensions are valid
*/
ve
.
dm
.
Scalable
.
prototype
.
isCurrentDimensionsValid
=
function
()
{
const
dimensions
=
this
.
getCurrentDimensions
(),
minDimensions
=
this
.
isEnforcedMin
()
&&
!
ve
.
isEmptyObject
(
this
.
getMinDimensions
()
)
&&
this
.
getMinDimensions
(),
maxDimensions
=
this
.
isEnforcedMax
()
&&
!
ve
.
isEmptyObject
(
this
.
getMaxDimensions
()
)
&&
this
.
getMaxDimensions
();
this
.
valid
=
(
!!
dimensions
&&
// Dimensions must be non-zero
+
dimensions
.
width
&&
+
dimensions
.
height
&&
(
!
minDimensions
||
(
dimensions
.
width
>=
minDimensions
.
width
&&
dimensions
.
height
>=
minDimensions
.
height
)
)
&&
(
!
maxDimensions
||
(
dimensions
.
width
<=
maxDimensions
.
width
&&
dimensions
.
height
<=
maxDimensions
.
height
)
)
);
return
this
.
valid
;
};
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sun, Nov 22, 04:50 (1 d, 4 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
d2/b3/ea218cf57a2995cc5dd0e855aeca
Default Alt Text
ve.dm.Scalable.js (17 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment