Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /*!
* VisualEditor UserInterface MediaSizeWidget class.
*
* @copyright See AUTHORS.txt
*/
/**
* Widget that lets the user edit dimensions (width and height),
* based on a scalable object.
*
* @class
* @extends OO.ui.Widget
*
* @constructor
* @param {ve.dm.Scalable} [scalable]
* @param {Object} [config] Configuration options
* @cfg {boolean} [noDefaultDimensions] The item being sized doesn't have default dimensions
* @cfg {string} [dimensionsAlign] Alignment for the dimensions widget
*/
ve.ui.MediaSizeWidget = function VeUiMediaSizeWidget( scalable, config ) {
// Configuration
config = config || {};
this.scalable = scalable;
// Parent constructor
ve.ui.MediaSizeWidget.super.call( this, config );
// Properties
this.ratio = {};
this.currentDimensions = {};
this.maxDimensions = {};
this.valid = null;
this.noDefaultDimensions = !!config.noDefaultDimensions;
this.dimensionsAlign = config.dimensionsAlign || 'right';
// Define button select widget
this.sizeTypeSelect = new OO.ui.ButtonSelectWidget( {
classes: [ 've-ui-mediaSizeWidget-section-sizetype' ]
} );
this.sizeTypeSelect.addItems( [
new OO.ui.ButtonOptionWidget( {
data: 'default',
label: ve.msg( 'visualeditor-mediasizewidget-sizeoptions-default' )
} ),
// TODO: when upright is supported by Parsoid
// new OO.ui.ButtonOptionWidget( {
// data: 'scale',
// label: ve.msg( 'visualeditor-mediasizewidget-sizeoptions-scale' )
// } ),
new OO.ui.ButtonOptionWidget( {
data: 'custom',
label: ve.msg( 'visualeditor-mediasizewidget-sizeoptions-custom' )
} )
] );
var sizeTypeField = new OO.ui.FieldLayout( this.sizeTypeSelect );
// Define scale
/*
this.scaleInput = new OO.ui.TextInputWidget();
scalePercentLabel = new OO.ui.LabelWidget( {
input: this.scaleInput,
label: ve.msg( 'visualeditor-mediasizewidget-label-scale-percent' )
} );
*/
this.dimensions = new ve.ui.DimensionsWidget( { validate: this.isValid.bind( this ) } );
// Error label is available globally so it can be displayed and
// hidden as needed
this.errorLabel = new OO.ui.LabelWidget( {
label: ve.msg( 'visualeditor-mediasizewidget-label-defaulterror' )
} );
// Field layouts
/*
scaleField = new OO.ui.FieldLayout(
this.scaleInput, {
align: 'right',
// TODO: when upright is supported by Parsoid
// classes: ['ve-ui-mediaSizeWidget-section-scale'],
label: ve.msg( 'visualeditor-mediasizewidget-label-scale' )
}
);
TODO: when upright is supported by Parsoid
this.scaleInput.$element.append( scalePercentLabel.$element );
*/
var dimensionsField = new OO.ui.FieldLayout(
this.dimensions, {
align: this.dimensionsAlign,
classes: [ 've-ui-mediaSizeWidget-section-custom' ]
}
);
// Build GUI
this.$element.addClass( 've-ui-mediaSizeWidget' );
if ( !this.noDefaultDimensions ) {
this.$element.append( sizeTypeField.$element );
}
this.$element.append( dimensionsField.$element );
// TODO: when upright is supported by Parsoid
// this.$element.append( scaleField.$element );
this.$element.append(
$( '<div>' )
.addClass( 've-ui-mediaSizeWidget-label-error' )
.append( this.errorLabel.$element )
);
// Events
this.dimensions.connect( this, {
widthChange: [ 'onDimensionsChange', 'width' ],
heightChange: [ 'onDimensionsChange', 'height' ]
} );
// TODO: when upright is supported by Parsoid
// this.scaleInput.connect( this, { change: 'onScaleChange' } );
this.sizeTypeSelect.connect( this, { choose: 'onSizeTypeChoose' } );
};
/* Inheritance */
OO.inheritClass( ve.ui.MediaSizeWidget, OO.ui.Widget );
/* Events */
/**
* @event change
* @param {Object} dimensions Width and height dimensions
*/
/**
* @event valid
* @param {boolean} isValid Current dimensions are valid
*/
/**
* @event changeSizeType
* @param {string} sizeType 'default', 'custom' or 'scale'
*/
/* Methods */
/**
* Respond to change in original dimensions in the scalable object.
* Specifically, enable or disable the 'default' option.
*
* @param {Object} dimensions Original dimensions
*/
ve.ui.MediaSizeWidget.prototype.onScalableOriginalSizeChange = function () {
// Revalidate current dimensions
this.updateDisabled();
this.validateDimensions();
};
/**
* Respond to change in current dimensions in the scalable object.
*
* @param {Object} dimensions Original dimensions
*/
ve.ui.MediaSizeWidget.prototype.onScalableCurrentSizeChange = function ( dimensions ) {
if ( !ve.isEmptyObject( dimensions ) ) {
this.setCurrentDimensions( dimensions );
this.validateDimensions();
}
};
/**
* Respond to default size or status change in the scalable object.
*
* @param {boolean} isDefault Current default state
*/
ve.ui.MediaSizeWidget.prototype.onScalableDefaultSizeChange = function ( isDefault ) {
// Update the default size into the dimensions widget
this.updateDefaultDimensions();
// TODO: When 'scale' ('upright' support) is ready, this will need to be adjusted
// to support that as well
this.setSizeType(
isDefault ?
'default' :
'custom'
);
this.validateDimensions();
};
/**
* Respond to width/height input value change. Only update dimensions if
* the value is numeric. Invoke validation for every change.
*
* This is triggered every time the dimension widget has its values changed
* either by the user or externally. The external call to 'setCurrentDimensions'
* will result in this event being evoked if the dimension inputs have changed,
* and same with changing dimensions type.
*
* The 'change' event for the entire widget is emitted through this method, as
* it means that the actual values have changed, regardless of whether they
* are valid or not.
*
* @param {string} type The input that was updated, 'width' or 'height'
* @param {string} value The new value of the input
* @fires change
*/
ve.ui.MediaSizeWidget.prototype.onDimensionsChange = function ( type, value ) {
if ( +value === 0 && !this.noDefaultDimensions ) {
this.setSizeType( 'default' );
} else {
this.setSizeType( 'custom' );
if ( !isNaN( +value ) ) {
var dimensions = {};
dimensions[ type ] = +value;
this.setCurrentDimensions( dimensions );
} else {
this.validateDimensions();
}
}
};
// /**
// * Respond to change of the scale input
// */
/*
ve.ui.MediaSizeWidget.prototype.onScaleChange = function () {
// If the input changed (and not empty), set to 'custom'
// Otherwise, set to 'default'
if ( !this.dimensions.isEmpty() ) {
this.sizeTypeSelect.selectItemByData( 'scale' );
} else {
this.sizeTypeSelect.selectItemByData( 'default' );
}
};
*/
/**
* Respond to size type change
*
* @param {OO.ui.OptionWidget} item Selected size type item
* @fires changeSizeType
*/
ve.ui.MediaSizeWidget.prototype.onSizeTypeChoose = function ( item ) {
var selectedType = item.getData(),
wasDefault = this.scalable.isDefault();
this.scalable.toggleDefault( selectedType === 'default' );
if ( selectedType === 'default' ) {
// If there are defaults, put them into the values
if ( !ve.isEmptyObject( this.dimensions.getDefaults() ) ) {
this.dimensions.clear();
}
} else if ( selectedType === 'custom' ) {
// If we were default size before, set the current dimensions to the default size
if ( wasDefault && !ve.isEmptyObject( this.dimensions.getDefaults() ) ) {
this.setCurrentDimensions( this.dimensions.getDefaults() );
}
this.validateDimensions();
}
this.emit( 'changeSizeType', selectedType );
this.updateDisabled();
this.validateDimensions();
};
// /**
// * Set the placeholder value of the scale input
// *
// * @param {number} value Placeholder value
// * @chainable
// * @return {ve.ui.MediaSizeWidget}
// */
/*
ve.ui.MediaSizeWidget.prototype.setScalePlaceholder = function ( value ) {
this.scaleInput.$element.prop( 'placeholder', value );
return this;
};
*/
// /**
// * Get the placeholder value of the scale input
// *
// * @return {string} Placeholder value
// */
/*
ve.ui.MediaSizeWidget.prototype.getScalePlaceholder = function () {
return this.scaleInput.$element.prop( 'placeholder' );
};
*/
/**
* Select a size type in the select widget
*
* @param {string} sizeType The size type to select
* @chainable
* @return {ve.ui.MediaSizeWidget}
*/
ve.ui.MediaSizeWidget.prototype.setSizeType = function ( sizeType ) {
if (
this.getSizeType() !== sizeType ||
// If the dimensions widget has zeros make sure to
// allow for the change in size type
+this.dimensions.getWidth() === 0 ||
+this.dimensions.getHeight() === 0
) {
this.sizeTypeSelect.chooseItem(
this.sizeTypeSelect.findItemFromData( sizeType )
);
}
return this;
};
/**
* Get the size type from the select widget
*
* @return {string} The size type
*/
ve.ui.MediaSizeWidget.prototype.getSizeType = function () {
return this.sizeTypeSelect.findSelectedItem() ? this.sizeTypeSelect.findSelectedItem().getData() : '';
};
/**
* Set the scalable object the widget deals with
*
* @param {ve.dm.Scalable} scalable A scalable object representing the media source being resized.
* @chainable
* @return {ve.ui.MediaSizeWidget}
*/
ve.ui.MediaSizeWidget.prototype.setScalable = function ( scalable ) {
if ( this.scalable instanceof ve.dm.Scalable ) {
this.scalable.disconnect( this );
}
this.scalable = scalable;
// Events
this.scalable.connect( this, {
defaultSizeChange: 'onScalableDefaultSizeChange',
originalSizeChange: 'onScalableOriginalSizeChange',
currentSizeChange: 'onScalableCurrentSizeChange'
} );
this.updateDefaultDimensions();
if ( !this.scalable.isDefault() ) {
// Reset current dimensions to new scalable object
this.setCurrentDimensions( this.scalable.getCurrentDimensions() );
}
// Call for the set size type according to default or custom settings of the scalable
if ( this.scalable.getOriginalDimensions() ) {
this.setSizeType( this.scalable.isDefault() ? 'default' : 'custom' );
}
this.updateDisabled();
this.validateDimensions();
return this;
};
/**
* Get the attached scalable object
*
* @return {ve.dm.Scalable} The scalable object representing the media
* source being resized.
*/
ve.ui.MediaSizeWidget.prototype.getScalable = function () {
return this.scalable;
};
/**
* Set the image aspect ratio explicitly
*
* @param {number} ratio Numerical value of an aspect ratio
* @chainable
* @return {ve.ui.MediaSizeWidget}
*/
ve.ui.MediaSizeWidget.prototype.setRatio = function ( ratio ) {
this.scalable.setRatio( ratio );
return this;
};
/**
* Get the current aspect ratio
*
* @return {number} Aspect ratio
*/
ve.ui.MediaSizeWidget.prototype.getRatio = function () {
return this.scalable.getRatio();
};
/**
* Set the maximum dimensions for the image. These will be limited only if
* enforcedMax is true.
*
* @param {Object} dimensions Height and width
* @chainable
* @return {ve.ui.MediaSizeWidget}
*/
ve.ui.MediaSizeWidget.prototype.setMaxDimensions = function ( dimensions ) {
// Normalize dimensions before setting
var maxDimensions = ve.dm.Scalable.static.getDimensionsFromValue( dimensions, this.scalable.getRatio() );
this.scalable.setMaxDimensions( maxDimensions );
return this;
};
/**
* Retrieve the currently defined maximum dimensions
*
* @return {Object} dimensions Height and width
*/
ve.ui.MediaSizeWidget.prototype.getMaxDimensions = function () {
return this.scalable.getMaxDimensions();
};
/**
* Retrieve the current dimensions
*
* @return {Object} Width and height
*/
ve.ui.MediaSizeWidget.prototype.getCurrentDimensions = function () {
return this.currentDimensions;
};
/**
* @inheritdoc
*/
ve.ui.MediaSizeWidget.prototype.setDisabled = function ( disabled ) {
// Parent method
ve.ui.MediaSizeWidget.super.prototype.setDisabled.call( this, disabled );
this.updateDisabled();
return this;
};
/**
* Update the disabled state of sub widgets
*
* @chainable
* @return {ve.ui.MediaSizeWidget}
*/
ve.ui.MediaSizeWidget.prototype.updateDisabled = function () {
var disabled = this.isDisabled();
// The 'updateDisabled' method may called before the widgets
// are fully defined. So, before disabling/enabling anything,
// make sure the objects exist
if ( this.sizeTypeSelect &&
this.dimensions &&
this.scalable
) {
var sizeType = this.getSizeType();
// Disable the type select
this.sizeTypeSelect.setDisabled( disabled );
// Disable the default type options
this.sizeTypeSelect.findItemFromData( 'default' ).setDisabled(
ve.isEmptyObject( this.scalable.getDefaultDimensions() )
);
// Disable the dimensions widget
this.dimensions.setDisabled( disabled || sizeType !== 'custom' );
// Disable the scale widget
// this.scaleInput.setDisabled( disabled || sizeType !== 'scale' );
}
return this;
};
/**
* Updates the current dimensions in the inputs, either one at a time or both
*
* @param {Object} dimensions Dimensions with width and height
* @fires change
*/
ve.ui.MediaSizeWidget.prototype.setCurrentDimensions = function ( dimensions ) {
// Recursion protection
if ( this.preventChangeRecursion ) {
return;
}
this.preventChangeRecursion = true;
if ( !this.scalable.isFixedRatio() ) {
dimensions = ve.extendObject( {}, this.getCurrentDimensions(), dimensions );
}
// Normalize the new dimensions
var normalizedDimensions = ve.dm.Scalable.static.getDimensionsFromValue( dimensions, this.scalable.getRatio() );
if (
// Update only if the dimensions object is valid
ve.dm.Scalable.static.isDimensionsObjectValid( normalizedDimensions ) &&
// And only if the dimensions object is not default
!this.scalable.isDefault()
) {
this.currentDimensions = normalizedDimensions;
// This will only update if the value has changed
// Set width & height individually as they may be 0
this.dimensions.setWidth( this.currentDimensions.width );
this.dimensions.setHeight( this.currentDimensions.height );
// Update scalable object
this.scalable.setCurrentDimensions( this.currentDimensions );
this.validateDimensions();
// Emit change event
this.emit( 'change', this.currentDimensions );
}
this.preventChangeRecursion = false;
};
/**
* Validate current dimensions.
* Explicitly call for validating the current dimensions. This is especially
* useful if we've changed conditions for the widget, like limiting image
* dimensions for thumbnails when the image type changes. Triggers the error
* class if needed.
*
* @return {boolean} Current dimensions are valid
*/
ve.ui.MediaSizeWidget.prototype.validateDimensions = function () {
var isValid = this.isValid();
if ( this.valid !== isValid ) {
this.valid = isValid;
this.errorLabel.toggle( !isValid );
this.dimensions.setValidityFlag();
// Emit change event
this.emit( 'valid', this.valid );
}
return isValid;
};
/**
* Set default dimensions for the widget. Values are given by scalable's
* defaultDimensions. If no default dimensions are available,
* the defaults are removed.
*/
ve.ui.MediaSizeWidget.prototype.updateDefaultDimensions = function () {
var defaultDimensions = this.scalable.getDefaultDimensions();
if ( !ve.isEmptyObject( defaultDimensions ) ) {
this.dimensions.setDefaults( defaultDimensions );
} else {
this.dimensions.removeDefaults();
}
this.updateDisabled();
this.validateDimensions();
};
/**
* Check if the custom dimensions are empty.
*
* @return {boolean} Both width/height values are empty
*/
ve.ui.MediaSizeWidget.prototype.isCustomEmpty = function () {
return this.dimensions.isEmpty();
};
// /**
// * Check if the scale input is empty.
// *
// * @return {boolean} Scale input value is empty
// */
/*
ve.ui.MediaSizeWidget.prototype.isScaleEmpty = function () {
return ( this.scaleInput.getValue() === '' );
};
*/
/**
* Check if all inputs are empty.
*
* @return {boolean} All input values are empty
*/
ve.ui.MediaSizeWidget.prototype.isEmpty = function () {
return this.isCustomEmpty();
// return this.isCustomEmpty() && this.isScaleEmpty();
};
/**
* Check whether the current value inputs are valid
* 1. If placeholders are visible, the input is valid
* 2. If inputs have non numeric values, input is invalid
* 3. If inputs have numeric values, validate through scalable
* calculations to see if the dimensions follow the rules.
*
* @return {boolean} Valid or invalid dimension values
*/
ve.ui.MediaSizeWidget.prototype.isValid = function () {
var itemType = this.sizeTypeSelect.findSelectedItem() ?
this.sizeTypeSelect.findSelectedItem().getData() : 'custom';
// TODO: when upright is supported by Parsoid add validation for scale
if ( itemType === 'custom' ) {
if (
this.dimensions.getDefaults() &&
this.dimensions.isEmpty()
) {
return true;
} else if (
!isNaN( +this.dimensions.getWidth() ) &&
!isNaN( +this.dimensions.getHeight() )
) {
return this.scalable.isCurrentDimensionsValid();
} else {
return false;
}
} else {
// Default images are always valid size
return true;
}
};
|