MD_PropEditBase

public class MD_PropEditBase : GoMetaDialog

Base class to access property editor metadialog.

Inheritance:

MD_PropEditBase

Fields
public var mPropImages: Hash table of property values
public var mProps: Hash table of Properties
public var mPropValueLists: Hash table of property values
public static var sDialogCancelled: 1 if last call of the dialog has been cancelled
public static var sLastResult: cached last result value
public static var sResetLastResult: reset last result value on next call of MetaDialog

Methods
public func getMDDialogCaption(pLang): Returns the caption of the dialog
public func getMDDialogHeight(): Returns the height of the dialog
public func getMDDialogWidth(): Returns the width of the dialog
public func getPropValue(pKey): Returns the value of a property
public func importFromArticlePropDef(pKey, pPropDef, pClass, pVisibility, pDefault, pUpdate, pPosition, pPropPicPrefix): Creates a property, using the standard OFML property definition
public func setPropSensitive(pKey, pSensitive): Sets the editability of a property
public func setPropValue(pKey, pValue): Sets the value of a property
public func setPropVisible(pKey, pVisible): Sets the visibility of a property
public func setupProperty(pKey, pType, pClass, pText, pVisibility, pDefault, pArgs, pAdditional, pUpdate, pPosition): Creates a property
public func setupProps(): Called to initialize properties
public func updateProps(pKey): Called when a property has been changed

Documentation

PURPOSE:
Base class to access property editor metadialog ::ofml::go::md_propedit.dll
INHERITS: -
USES: -

public var mProps

Hash table of Properties.: [Index, PropertyType, Arguments, PropertyValue, Visibility, Additional Values].

@ch - ChoiceList
@i - Integer
@f - Float
@s - String
@g - Group
@b - Boolean (only new version)
@chi - ChoiceList of Integers (only new version)
@chf - ChoiceList of Floats (only new version)

in case of @ch - unused
in case of @i or @f - [Minimum, Maximum value]; use NULL if no min/max
in case of @s - maximum number of characters (may be NULL)
in case of @g - List of Properties inside this group

0 - invisible
1 - visible but not editable
3 - visible and editable

public var mPropValueLists

Hash table of property values.
Hash key is the property key

public var mPropImages

Hash table of property values.
Hash key is param2Str([property key, property value])

public static var sLastResult

cached last result value

public static var sDialogCancelled

1 if last call of the dialog has been cancelled

public static var sResetLastResult

reset last result value on next call of MetaDialog.
can be overridden to 0 in derived classes

public func getMDDialogCaption(pLang)

Returns the caption of the dialog.

IN

String pLang language

String pText the resolved text

public func getMDDialogHeight()

Returns the height of the dialog.

IN

-

Integer pHeight - The height of the dialog.

public func getMDDialogWidth()

Returns the width of the dialog.

IN

-

Integer pWidth - The width of the dialog.

public func setupProps()

Called to initialize properties.
To be overridden in derived classes.

IN

-

-

public func importFromArticlePropDef(pKey, pPropDef, pClass, pVisibility, pDefault, pUpdate, pPosition, pPropPicPrefix)

Creates a property, using the standard OFML property definition.

IN

Symbol pKey - key of the property
Any[5] pPropDef - OFML property definition
Symbol pClass - the property class
Integer pVisibility - Visibility of the property:

0 - property is invisible
1 - property is visible, but read-only
3 - property is visible and can be edited

Any pDefault - Default value of the property
Integer pUpdate - Flag if property change triggers method updateProps(pKey)
Integer pPosition - Position of the property
String pPropPicPrefix - Property picture prefix (use NULL if no property pictures are needed).
The prefix can contain the reference to a different manufacturer / package (e.g. "::man::series::Pic")
The pictures need to be available in the mat folder of the recent sales region of the package.

-

public func setupProperty(pKey, pType, pClass, pText, pVisibility, pDefault, pArgs, pAdditional, pUpdate, pPosition)

Creates a property.

IN

Symbol pKey - key of the property
Symbol pType - type of the property:

@i - Integer
@s - String
@f - Float
@b - Boolean
@ch - Choice list of symbols
@chi - Choice list of integers
@chf - Choice list of floats

Symbol pClass - the property class
Symbol or String pText - the property description. This can be a resolved text or the reference to a OFML string resource
Integer pVisibility - Visibility of the property:

0 - property is invisible
1 - property is visible, but read-only
3 - property is visible and can be edited

Any pDefault - Default value of the property
Any pArgs - Arguments of the property, depending on it's type:

In case of @ch, @chi, @chf - property value list. Each entry contains:
- Symbol value
- String text or NULL
- optional String property picture. This value can contain the reference to a different manufacturer / package (e.g. "::man::series::value1")
  The pictures need to be available in the mat folder of the recent sales region of the package.
In case of @i or @f - [Minimum, Maximum value]; use NULL if no min/max
In case of @s - maximum number of characters (may be NULL)
In case of @g - list of properties inside this group

Integer pAdditional - flag if property can have addional values. Only needed for choice list properties.
Integer pUpdate - flag if property change triggers method updateProps(pKey)
Integer pPosition - position of the property

-

public func getPropValue(pKey)

Returns the value of a property.
IN

Symbol pKey - property key

Any pValue - property value

public func setPropValue(pKey, pValue)

Sets the value of a property.
IN

Symbol pKey - property key
Any pValue - property value

-

public func setPropVisible(pKey, pVisible)

Sets the visibility of a property.
IN

Symbol pKey - property key
Integer pVisible - visibility of the property:
- 0 - property is invisible
- 1 - property is visible

-

public func setPropSensitive(pKey, pSensitive)

Sets the editability of a property.
IN

Symbol pKey - property key
Integer pSensitive - visibility of the property:
- 0 - property cannot be edited
- 1 - property can be edited

-

public func updateProps(pKey)

Called when a property has been changed.
IN

Symbol pKey - key of the changed property

-

This class has no child classes.

Author:: Andy Kittner, Andreas Handschuh, EasternGraphics

top page alphabetic index hierarchy of classes

© 1999-2016 EasternGraphics GmbH

generated by doc++