jet.controls
Class JetProperty

java.lang.Object
  jet.controls.JetProperty

All Implemented Interfaces:

jet.convert.PropInfo, jet.util.Propertiable

Direct Known Subclasses:

JetBoolean, JetColor, JetCommand, JetEnumeration, JetNumber, JetReference, JetString, JetVector

public abstract class JetProperty
extends java.lang.Object
implements jet.util.Propertiable, jet.convert.PropInfo

The base class of all the property

property includes four parts so far: owner, name, value status, edit attribute.

• edit attribute is only for the Designer UI such as editor, editor status, value change listener, property choice...
• value status, in general, can be divided into normal value, default value, ChangeBy value. The priority in use is ChangeBy value > normal value > default value
  ChangeBy value, the description of 'changed by' and actual value must be calculated based on runtime context, contains 'another object', 'conditional formatting'(since V9), 'on the fly formula'(since V9). The priority in use is 'conditional formatting' > 'on the fly formula' > 'another object'

Additional:

1. It contains a attribute for 'export to RST': can export to rst?
2. It contains an inner type for 'export', such as Propertiable.IGNORED,Propertiable.BOOLEAN....(detail please refer to Propertiable)
3. In most running, 'ChagneBy value' can not used to calculate directly, so attribute runtime change by had been appended(since V10). It is always set/reset when preparing (to run)

Field Summary

static int	CHART_BACKGROUND_EDITOR Editor: CHART_BACKGROUND_EDITOR;ONLY For Designer UI
static int	CHART_FILLPATTERN_EDITOR Editor: CHART_FILLPATTERN_EDITOR;ONLY For Designer UI
static int	CHART_FILTER_EDITOR Editor: CHART_FILTER_EDITOR; ONLY For Designer UI
static int	CHART_FILTER_EDITOR_NO_DATE Editor: CHART_FILTER_EDITOR_NO_DATE; ONLY For Designer UI
static int	CHART_ICON_STYLE Editor: CHART_ICON_STYLE;ONLY For Designer UI
static int	CHART_PATTERN_LIST_EDITOR Editor: CHART_PATTERN_LIST_EDITOR;ONLY For Designer UI
static int	CHART_PENSTYLE_EDITOR Editor: CHART_PENSTYLE_EDITOR;ONLY For Designer UI
static int	CHART_TEXTSTYLE_EDITOR Editor: CHART_TEXTSTYLE_EDITOR;ONLY For Designer UI
static int	CHOICE_EDITOR Editor: CHOICE_EDITOR;ONLY For Designer UI
static int	COLOR_EDITOR Editor: COLOR_EDITOR;ONLY For Designer UI
static int	COMBO_EDITOR Editor: COMBO_EDITOR;ONLY For Designer UI
static int	COMMAND_EDITOR Editor: COMMAND_EDITOR;ONLY For Designer UI
static int	CONTROL_SELECT_ITEMS Editor: CONTROL_SELECT_ITEMS; ONLY For Designer UI
static int	DATASOURCE_EDITOR Editor: DATASOURCE_EDITOR; ONLY For Designer UI
static int	DBCOL_EDITOR Editor: DBCOL_EDITOR;ONLY For Designer UI
static int	DETAIL_REPORT_EDITOR Editor: DETAIL_REPORT_EDITOR;ONLY For Designer UI
static int	EDIT_FORBIDDEN editor status: EDIT_FORBIDDEN;, ONLY For Designer UI
static int	EDIT_FORBIDDEN_INIT editor status: EDIT_FORBIDDEN_INIT; ONLY For Designer UI
static int	EDITABLE_ALLTIME editor status: EDITABLE_ALLTIME; ONLY For Designer UI
static int	INTERNAL editor status: INTERNAL; ONLY For Designer UI
static int	LINK_EDITOR Editor: LINK_EDITOR;ONLY For Designer UI
static int	MULSEL_EDITOR Editor: MULSEL_EDITOR;ONLY For Designer UI
static int	PARAMCOL_EDITOR Editor: PARAMCOL_EDITOR;ONLY For Designer UI
static int	QUERY_EDITOR Editor: QUERY_EDITOR;ONLY For Designer UI
static int	RECORDDB_EDITOR Editor: RECORDDB_EDITOR;ONLY For Designer UI
static int	SECURITY_EDITOR Editor: SECURITY_EDITOR;ONLY For Designer UI
static int	TEXT_EDITOR Editor: TEXT_EDITOR;ONLY For Designer UI

Fields inherited from interface jet.util.Propertiable

BIGSTRING, BOOLEAN, CHG_FMTTINGBLNAME, CHG_FMTTINGFORMULA, CHG_OTHER, COLOR, CUSTOMER, CUSTOMERLINK, DELIM, DOUBLE, ENUMERATION, IGNORED, IMAGE, IMGVECTOR, MAPPINGTBL, NUMBER, REFERENCE, STRING, UNIT, VAL_NORMALLENGTH, VAL_NORMALSTART, VECTOR

Constructor Summary

JetProperty()

JetProperty(jet.controls.JetObject parent, java.lang.String name)

Method Summary

boolean	canChangeByBL() Can the property be changed by 'on the fly formula'
boolean	canChangeByFmtt() Can the property be changed by 'conditional formatting'
boolean	canChangeByOthers() Can the property be changed by 'another object'
void	enableAllChangeBys(boolean bEnable) Batch set can the property be changed by ChangeBy value
jet.controls.JetChangeBy	getChangeBy() Deprecated.
java.lang.Object	getChangeByBL()
java.lang.String	getChangeByBLName() Deprecated.
java.lang.Object	getChangeByFmtt()
java.lang.String	getChangeByFmttName() Deprecated.
java.lang.Object	getChangeByObject()
java.lang.String	getChangeByObjectName() Deprecated.
int	getEditFlag() Only for Designer UI.
int	getEditorType() Only For Designer UI.
java.lang.String	getInspValue() Only For Designer UI.
java.lang.String	getInspValue(int unit, int fraction) Deprecated.
int[]	getMatchingSqlType() Now, this API only for designer UI : get Matching SQL Type of this property Usage in UI : list all the (normal-)formula whose data-type in returned array
java.lang.String	getName()
java.lang.Object	getNormalObject() According to the following priority return : normal value > default value
java.lang.Object	getObject() According to the following priority return : 'another object' > normal value > default value Notice: returned 'another object' is the description of 'changed by'
jet.controls.JetObject	getParent()
java.util.Vector	getPropertyChoice() Only For Designer UI
int	getPropType()
java.lang.Object	getRuntimeChangeBy()
java.lang.Object	getUnifiedObject() According to the following priority return : ChangeBy value > normal value > default value Notice: returned ChangeBy value is the description of 'changed by'
java.lang.Object	getValue()
boolean	isChagneByFmtt()
boolean	isChangeByBL()
boolean	isChangeByOther()
boolean	isNull() Is set normal value? Notice: This function has disabled from V8.
boolean	isSetRuntimeChgBy() Is runtime change by set?
boolean	isTransient() Gets attribute for 'export to RST'.
void	loadFullChangeBy(java.lang.String changeBy) ONLY FOR LOAD CHANGE BY STRING
void	propertyChanged() Force refresh the property information that managed in/by owner. Note to developer: No 'call hierarchy' found, but maybe can be found in other products
java.lang.String	saveFullChangeBy() ONLY FOR SAVE CHANGE BY AS STRING Notice: Can called ONLY this property has ChangeBy value
void	set(java.lang.String theval) sets the normal value via a String.
void	setCanChangeByBL(boolean bSet) Sets can the property be changed by 'on the fly formula'
void	setCanChangeByFmtt(boolean bSet) Sets can the property be changed by 'conditional formatting'
void	setCanChangeByOthers(boolean bSet) Sets can the property be changed by 'another object'.
void	setChangeByBL(java.lang.Object obj) Sets properties value changing by 'on the fly formula' if canChangeByBL
void	setChangeByFmtt(java.lang.Object obj) Sets properties value changing by 'conditional formatting' if canChangeByFmtt
void	setChangeByObject(java.lang.Object obj) Sets properties value changing by 'another object' if canChangeByOther
void	setEditFlag(int flag) Only For Designer UI.Sets the editor status
void	setEditorType(int type) Only For Designer UI.
void	setObject(java.lang.Object value) Sets normal value
void	setRuntimeChangeBy(java.lang.Object runtimeChgBy) Sets runtime change by description.
void	setTransient(boolean tran) Sets attribute for 'export to RST'.
void	setUnitValue(java.lang.String theval) Sets the normal value via a String based on unit,
java.lang.String	toUnitString() Returns the unit value as string, the unit value is (with priority)normal value > default value

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jet.convert.PropInfo

toString

Field Detail

TEXT_EDITOR

public static int TEXT_EDITOR

Editor: TEXT_EDITOR;ONLY For Designer UI

COMBO_EDITOR

public static int COMBO_EDITOR

Editor: COMBO_EDITOR;ONLY For Designer UI

COLOR_EDITOR

public static int COLOR_EDITOR

Editor: COLOR_EDITOR;ONLY For Designer UI

COMMAND_EDITOR

public static int COMMAND_EDITOR

Editor: COMMAND_EDITOR;ONLY For Designer UI

CHOICE_EDITOR

public static int CHOICE_EDITOR

Editor: CHOICE_EDITOR;ONLY For Designer UI

DBCOL_EDITOR

public static int DBCOL_EDITOR

Editor: DBCOL_EDITOR;ONLY For Designer UI

PARAMCOL_EDITOR

public static int PARAMCOL_EDITOR

Editor: PARAMCOL_EDITOR;ONLY For Designer UI

QUERY_EDITOR

public static int QUERY_EDITOR

Editor: QUERY_EDITOR;ONLY For Designer UI

CHART_PATTERN_LIST_EDITOR

public static int CHART_PATTERN_LIST_EDITOR

Editor: CHART_PATTERN_LIST_EDITOR;ONLY For Designer UI

LINK_EDITOR

public static int LINK_EDITOR

Editor: LINK_EDITOR;ONLY For Designer UI

RECORDDB_EDITOR

public static int RECORDDB_EDITOR

Editor: RECORDDB_EDITOR;ONLY For Designer UI

MULSEL_EDITOR

public static int MULSEL_EDITOR

Editor: MULSEL_EDITOR;ONLY For Designer UI

CHART_FILTER_EDITOR

public static int CHART_FILTER_EDITOR

Editor: CHART_FILTER_EDITOR; ONLY For Designer UI

CHART_FILTER_EDITOR_NO_DATE

public static int CHART_FILTER_EDITOR_NO_DATE

Editor: CHART_FILTER_EDITOR_NO_DATE; ONLY For Designer UI

CHART_ICON_STYLE

public static int CHART_ICON_STYLE

Editor: CHART_ICON_STYLE;ONLY For Designer UI

DATASOURCE_EDITOR

public static int DATASOURCE_EDITOR

Editor: DATASOURCE_EDITOR; ONLY For Designer UI

SECURITY_EDITOR

public static int SECURITY_EDITOR

Editor: SECURITY_EDITOR;ONLY For Designer UI

DETAIL_REPORT_EDITOR

public static int DETAIL_REPORT_EDITOR

Editor: DETAIL_REPORT_EDITOR;ONLY For Designer UI

CONTROL_SELECT_ITEMS

public static int CONTROL_SELECT_ITEMS

Editor: CONTROL_SELECT_ITEMS; ONLY For Designer UI

EDIT_FORBIDDEN

public static final int EDIT_FORBIDDEN

editor status: EDIT_FORBIDDEN;, ONLY For Designer UI

See Also:

Constant Field Values

EDIT_FORBIDDEN_INIT

public static final int EDIT_FORBIDDEN_INIT

editor status: EDIT_FORBIDDEN_INIT; ONLY For Designer UI

See Also:

Constant Field Values

EDITABLE_ALLTIME

public static final int EDITABLE_ALLTIME

editor status: EDITABLE_ALLTIME; ONLY For Designer UI

See Also:

Constant Field Values

INTERNAL

public static final int INTERNAL

editor status: INTERNAL; ONLY For Designer UI

See Also:

Constant Field Values

CHART_TEXTSTYLE_EDITOR

public static int CHART_TEXTSTYLE_EDITOR

Editor: CHART_TEXTSTYLE_EDITOR;ONLY For Designer UI

CHART_PENSTYLE_EDITOR

public static int CHART_PENSTYLE_EDITOR

Editor: CHART_PENSTYLE_EDITOR;ONLY For Designer UI

CHART_FILLPATTERN_EDITOR

public static int CHART_FILLPATTERN_EDITOR

Editor: CHART_FILLPATTERN_EDITOR;ONLY For Designer UI

CHART_BACKGROUND_EDITOR

public static int CHART_BACKGROUND_EDITOR

Editor: CHART_BACKGROUND_EDITOR;ONLY For Designer UI

Constructor Detail

JetProperty

public JetProperty()

JetProperty

public JetProperty(jet.controls.JetObject parent,
                   java.lang.String name)

Parameters:

parent - owner

name - name

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface jet.convert.PropInfo

Returns:

name.

isNull

public boolean isNull()

Is set normal value?
Notice: This function has disabled from V8. It has not been deleted because it is an API in PropInfo.

Specified by:

isNull in interface jet.convert.PropInfo

Returns:

true | false.

getPropertyChoice

public java.util.Vector getPropertyChoice()

Only For Designer UI

Returns:

property choice

getObject

public java.lang.Object getObject()

According to the following priority return : 'another object' > normal value > default value
Notice: returned 'another object' is the description of 'changed by'

Specified by:

getObject in interface jet.util.Propertiable

See Also:

isChangeByOther()

getUnifiedObject

public java.lang.Object getUnifiedObject()

According to the following priority return : ChangeBy value > normal value > default value
Notice: returned ChangeBy value is the description of 'changed by'

Specified by:

getUnifiedObject in interface jet.util.Propertiable

Since:

V9

See Also:

isChagneByFmtt(), isChangeByBL(), isChangeByOther()

getNormalObject

public java.lang.Object getNormalObject()

According to the following priority return : normal value > default value

Specified by:

getNormalObject in interface jet.util.Propertiable

setObject

public void setObject(java.lang.Object value)

Sets normal value

Specified by:

setObject in interface jet.util.Propertiable

getValue

public java.lang.Object getValue()

Specified by:

getValue in interface jet.convert.PropInfo

Returns:

normal value

set

public void set(java.lang.String theval)

sets the normal value via a String.

Specified by:

set in interface jet.util.Propertiable

Throws:

jet.exception.UnsupportedFunctionException

See Also:

Object.toString()

setUnitValue

public void setUnitValue(java.lang.String theval)

Sets the normal value via a String based on unit,

Throws:

jet.exception.UnsupportedFunctionException

See Also:

toUnitString()

setEditorType

public void setEditorType(int type)

Only For Designer UI. Sets the editor type.

Parameters:

type -

See Also:

getEditorType()

getEditorType

public int getEditorType()

Only For Designer UI. Gets the editor type.

See Also:

setEditorType(int)

setChangeByObject

public final void setChangeByObject(java.lang.Object obj)

Sets properties value changing by 'another object' if canChangeByOther

Specified by:

setChangeByObject in interface jet.util.Propertiable

Parameters:

obj - 'another object''s description: it can be (normal-)formula-name, parameter-name and null means clear 'change by'.

See Also:

canChangeByOther, setCanChangeByOthers(boolean), enableAllChangeBys(boolean), isChangeByOther(), getChangeByObject()

setChangeByFmtt

public final void setChangeByFmtt(java.lang.Object obj)

Sets properties value changing by 'conditional formatting' if canChangeByFmtt

Specified by:

setChangeByFmtt in interface jet.util.Propertiable

Parameters:

obj - 'conditional formatting''s description and null means clear.

Since:

V9

See Also:

canChangeByFmtt, setCanChangeByFmtt(boolean), enableAllChangeBys(boolean), isChagneByFmtt(), getChangeByFmtt()

setChangeByBL

public final void setChangeByBL(java.lang.Object obj)

Sets properties value changing by 'on the fly formula' if canChangeByBL

Specified by:

setChangeByBL in interface jet.util.Propertiable

Parameters:

obj - 'on the fly formula''s description and null means clear.

Since:

V9

See Also:

canChangeByBL, setCanChangeByBL(boolean), enableAllChangeBys(boolean), isChangeByBL(), getChangeByBL()

getChangeByObject

public final java.lang.Object getChangeByObject()

Returns:

the description of 'another object'. null means no 'another object'.

See Also:

setChangeByObject(Object), isChangeByOther()

getChangeByFmtt

public final java.lang.Object getChangeByFmtt()

Specified by:

getChangeByFmtt in interface jet.util.Propertiable

Returns:

the description of 'conditional formatting'. null means no 'conditional formatting'.

Since:

V9

See Also:

setChangeByFmtt(Object), isChagneByFmtt()

getChangeByBL

public final java.lang.Object getChangeByBL()

Specified by:

getChangeByBL in interface jet.util.Propertiable

Returns:

the description of 'on the fly formula'. null means no 'on the fly formula'.

Since:

V9

See Also:

setChangeByBL(Object), isChangeByBL()

getChangeByObjectName

public final java.lang.String getChangeByObjectName()

Deprecated.

Specified by:

getChangeByObjectName in interface jet.convert.PropInfo

See Also:

getChangeByObject()

getChangeByFmttName

public final java.lang.String getChangeByFmttName()

Deprecated.

See Also:

getChangeByFmtt()

getChangeByBLName

public final java.lang.String getChangeByBLName()

Deprecated.

See Also:

getChangeByBL()

isChangeByOther

public boolean isChangeByOther()

Specified by:

isChangeByOther in interface jet.convert.PropInfo

Specified by:

isChangeByOther in interface jet.util.Propertiable

Returns:

is the properties changing by 'another object'.

See Also:

setChangeByObject(Object)

isChagneByFmtt

public boolean isChagneByFmtt()

Specified by:

isChagneByFmtt in interface jet.util.Propertiable

Returns:

is the properties changing by 'conditional formatting'

Since:

V9

See Also:

setChangeByFmtt(Object)

isChangeByBL

public boolean isChangeByBL()

Specified by:

isChangeByBL in interface jet.util.Propertiable

Returns:

is the properties changing by 'on the fly formula'

Since:

V9

See Also:

setChangeByBL(Object)

getChangeBy

public jet.controls.JetChangeBy getChangeBy()

Deprecated.

Returned JetChangeBy is a unused class since V8.

See Also:

getChangeByObject()

setCanChangeByOthers

public void setCanChangeByOthers(boolean bSet)

Sets can the property be changed by 'another object'.

See Also:

canChangeByOther, canChangeByOthers(), enableAllChangeBys(boolean)

setCanChangeByFmtt

public void setCanChangeByFmtt(boolean bSet)

Sets can the property be changed by 'conditional formatting'

Since:

V9

See Also:

canChangeByFmtt, canChangeByFmtt(), enableAllChangeBys(boolean)

setCanChangeByBL

public void setCanChangeByBL(boolean bSet)

Sets can the property be changed by 'on the fly formula'

Since:

V9

See Also:

canChangeByBL, canChangeByBL(), enableAllChangeBys(boolean)

enableAllChangeBys

public void enableAllChangeBys(boolean bEnable)

Batch set can the property be changed by ChangeBy value

Parameters:

bEnable -

Since:

V10.1

See Also:

canChangeByOther, canChangeByBL, canChangeByFmtt, setCanChangeByBL(boolean), setCanChangeByFmtt(boolean), setCanChangeByOthers(boolean), canChangeByBL(), canChangeByFmtt(), canChangeByOthers()

canChangeByOthers

public boolean canChangeByOthers()

Can the property be changed by 'another object'

Returns:

true(can) | false (can't)

See Also:

canChangeByOther, setCanChangeByOthers(boolean), enableAllChangeBys(boolean)

canChangeByFmtt

public boolean canChangeByFmtt()

Can the property be changed by 'conditional formatting'

Returns:

true(can) | false (can't)

Since:

V9

See Also:

canChangeByFmtt, setCanChangeByFmtt(boolean), enableAllChangeBys(boolean)

canChangeByBL

public boolean canChangeByBL()

Can the property be changed by 'on the fly formula'

Returns:

true(can) | false (can't)

Since:

V9

See Also:

canChangeByBL, setCanChangeByBL(boolean), enableAllChangeBys(boolean)

saveFullChangeBy

public java.lang.String saveFullChangeBy()

ONLY FOR SAVE CHANGE BY AS STRING
Notice: Can called ONLY this property has ChangeBy value

Specified by:

saveFullChangeBy in interface jet.util.Propertiable

Returns:

a string followed:
RETURNED ::= CHANGEBY (VALUEDESC)?
CHANGEBY ::= 'another object' DELIM 'conditional formatting' DELIM 'on the fly formula'
DELIM ::= (char)7
VALUEDESC ::= DELIM DELIMCOUNT DELIM UNITVALUE
DELIMCOUNT::= the count of the DELIM used in UNITVALUE
UNITVALUE ::= encoded string value in unit*
OTHER:
1.(VALUEDESC) will not created if this property ONLY changedByOther
2. Some Properties' Unit-value may contains DELIM like JetVector

Since:

V9

See Also:

loadFullChangeBy(String)

loadFullChangeBy

public void loadFullChangeBy(java.lang.String changeBy)

ONLY FOR LOAD CHANGE BY STRING

Specified by:

loadFullChangeBy in interface jet.util.Propertiable

Parameters:

changeBy - it MUST FIT following regular-expression:
INPUT ::= CHANGEBY | (CHANGEBY (VALUEDESC)?)
CHANGEBY ::= 'another object' DELIM 'conditional formatting' DELIM 'on the fly formula'
DELIM ::= (char)7
VALUEDESC ::= DELIM DELIMCOUNT DELIM UNITVALUE
DELIMCOUNT::= the count of the DELIM used in UNITVALUE
UNITVALUE ::= encoded string value of unit

Since:

V9

See Also:

saveFullChangeBy()

propertyChanged

public void propertyChanged()

Force refresh the property information that managed in/by owner.
Note to developer: No 'call hierarchy' found, but maybe can be found in other products

toUnitString

public java.lang.String toUnitString()

Returns the unit value as string, the unit value is (with priority)normal value > default value

Specified by:

toUnitString in interface jet.convert.PropInfo

Returns:

the string

See Also:

Object.toString()

getInspValue

public java.lang.String getInspValue(int unit,
                                     int fraction)

Deprecated.

Only For Designer UI.

See Also:

getInspValue()

getInspValue

public java.lang.String getInspValue()

Only For Designer UI. In most cases, return string based on unit

Specified by:

getInspValue in interface jet.convert.PropInfo

setEditFlag

public void setEditFlag(int flag)

Only For Designer UI.Sets the editor status

Parameters:

flag - one of EDIT_FORBIDDEN , EDIT_FORBIDDEN_INIT , EDITABLE_ALLTIME and INTERNAL

getEditFlag

public int getEditFlag()

Only for Designer UI. Gets the editor status

Returns:

one of EDIT_FORBIDDEN , EDIT_FORBIDDEN_INIT , EDITABLE_ALLTIME and INTERNAL

getParent

public jet.controls.JetObject getParent()

Returns:

the owner.

getPropType

public int getPropType()

Specified by:

getPropType in interface jet.util.Propertiable

Returns:

the inner type for 'export',

See Also:

Propertiable

getMatchingSqlType

public int[] getMatchingSqlType()

Now, this API only for designer UI : get Matching SQL Type of this property
Usage in UI : list all the (normal-)formula whose data-type in returned array

See Also:

Db

setTransient

public void setTransient(boolean tran)

Sets attribute for 'export to RST'.

Parameters:

tran - true means not export to rst.

See Also:

bTransient, isTransient()

isTransient

public boolean isTransient()

Gets attribute for 'export to RST'.

Returns:

true(not export to) | false(export to)

See Also:

bTransient, setTransient(boolean)

getRuntimeChangeBy

public java.lang.Object getRuntimeChangeBy()

Specified by:

getRuntimeChangeBy in interface jet.util.Propertiable

Returns:

runtime change by or ChangeBy value if runtime change by does not set.

Since:

V10

See Also:

setRuntimeChangeBy(Object), isSetRuntimeChgBy()

setRuntimeChangeBy

public void setRuntimeChangeBy(java.lang.Object runtimeChgBy)

Sets runtime change by description.

Specified by:

setRuntimeChangeBy in interface jet.util.Propertiable

Since:

V10

isSetRuntimeChgBy

public boolean isSetRuntimeChgBy()

Is runtime change by set?

Specified by:

isSetRuntimeChgBy in interface jet.util.Propertiable

Since:

V10