PatternBase

known direct subclasses: BackSlashPattern, SlashPattern

Base class for SVG pattern definitions.

Pattern is a built-in paint server in SVG. It provides tile-based patterns to the SVG 'fill' or 'stroke' attributes. See 'pattern' element in SVG.
See Pattern sample fro SVG specificiation 1.1

Constructor Summary

new sap.gantt.def.pattern.PatternBase(sId?, mSettings?)Creates and initializes a new SVG pattern defined for later reuse.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.gantt.def.pattern.PatternBase.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.def.pattern.PatternBase with name sClassName and enriches it with the information contained in oClassInfo.

sap.gantt.def.pattern.PatternBase.getMetadata()Returns a metadata object for class sap.gantt.def.pattern.PatternBase.

getBackgroundColor()Gets current value of property backgroundColor.

getBackgroundFillOpacity()Gets current value of property backgroundFillOpacity.

getTileHeight()Gets current value of property tileHeight.

getTileWidth()Gets current value of property tileWidth.

setBackgroundColor(sBackgroundColor)Sets a new value for property backgroundColor.

setBackgroundFillOpacity(sBackgroundFillOpacity)Sets a new value for property backgroundFillOpacity.

setTileHeight(iTileHeight)Sets a new value for property tileHeight.

setTileWidth(iTileWidth)Sets a new value for property tileWidth.

Methods borrowed from class sap.gantt.def.DefBase

generateRefId, getDefString, getRefString, setDefString, setRefString

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.gantt.def.pattern.PatternBase(sId?, mSettings?)

Creates and initializes a new SVG pattern defined for later reuse.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

Properties
- tileWidth : int (default: 8)
- tileHeight : int (default: 8)
- backgroundColor : sap.gantt.ValueSVGPaintServer (default: #fff)
- backgroundFillOpacity : number (default: 1)

In addition, all settings applicable to the base type sap.gantt.def.DefBase can be used as well.

Parameters:

{string}	sId?	ID of the new control, generated automatically if no ID is given
{object}	mSettings?	Initial settings for the new control

Method Detail

sap.gantt.def.pattern.PatternBase.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.gantt.def.pattern.PatternBase with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.gantt.def.DefBase.extend.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.gantt.def.pattern.PatternBase.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.gantt.def.pattern.PatternBase.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getBackgroundColor(): sap.gantt.ValueSVGPaintServer

Gets current value of property backgroundColor.

Background color of the pattern. Technically a rectangle with the color is added in the beginning of the pattern definition.

Default value is #fff.

Returns:

{sap.gantt.ValueSVGPaintServer} Value of property backgroundColor

getBackgroundFillOpacity(): number

Gets current value of property backgroundFillOpacity.

Fill opacity of background color.

Default value is 1.

Returns:

{number} Value of property backgroundFillOpacity

getTileHeight(): int

Gets current value of property tileHeight.

Height of the pattern tile. See 'height' attribute of 'pattern' element for detail.

Default value is 8.

Returns:

{int} Value of property tileHeight

getTileWidth(): int

Gets current value of property tileWidth.

Width of the pattern tile. See 'width' attribute of 'pattern' element for detail.

Default value is 8.

Returns:

{int} Value of property tileWidth

setBackgroundColor(sBackgroundColor): sap.gantt.def.pattern.PatternBase

Sets a new value for property backgroundColor.

Background color of the pattern. Technically a rectangle with the color is added in the beginning of the pattern definition.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is #fff.

Parameters:

{sap.gantt.ValueSVGPaintServer} sBackgroundColor New value for property backgroundColor

Returns:

{sap.gantt.def.pattern.PatternBase} Reference to this in order to allow method chaining

setBackgroundFillOpacity(sBackgroundFillOpacity): sap.gantt.def.pattern.PatternBase

Sets a new value for property backgroundFillOpacity.

Fill opacity of background color.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.

Parameters:

{number} sBackgroundFillOpacity New value for property backgroundFillOpacity

Returns:

{sap.gantt.def.pattern.PatternBase} Reference to this in order to allow method chaining

setTileHeight(iTileHeight): sap.gantt.def.pattern.PatternBase

Sets a new value for property tileHeight.

Height of the pattern tile. See 'height' attribute of 'pattern' element for detail.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 8.

Parameters:

{int} iTileHeight New value for property tileHeight

Returns:

{sap.gantt.def.pattern.PatternBase} Reference to this in order to allow method chaining

setTileWidth(iTileWidth): sap.gantt.def.pattern.PatternBase

Sets a new value for property tileWidth.

Width of the pattern tile. See 'width' attribute of 'pattern' element for detail.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 8.

Parameters:

{int} iTileWidth New value for property tileWidth

Returns:

{sap.gantt.def.pattern.PatternBase} Reference to this in order to allow method chaining