com.saperion.ngc.iform.field

Class TristateField

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Box

org.zkoss.zul.Hbox

com.saperion.ngc.iform.tristate.Tristate

com.saperion.ngc.iform.field.TristateField

All Implemented Interfaces:

EventChild, IntelligentField, Localized, Identifiable, Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.api.Box, org.zkoss.zul.api.Hbox, org.zkoss.zul.impl.api.XulElement

public class TristateField
extends Tristate
implements IntelligentField, Identifiable

A field in a form for boolean values that offers three states: checked, unchecked, no value.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.saperion.ngc.iform.tristate.Tristate

Tristate.Tristates

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Nested classes/interfaces inherited from interface com.saperion.ngc.iform.field.IntelligentField

IntelligentField.ElementType

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface com.saperion.ngc.events.EventChild

ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_RELEASE, ON_DOWNLOAD_RESULTITEM, ON_EDIT_CONTENT, ON_EDIT_FOLDER, ON_EDIT_ITEM, ON_EDIT_ITEM_SELECTED, ON_EDIT_LOOKUP, ON_EDIT_SELECTED, ON_EDIT_STRUCTURE, ON_EXPAND_NODE, ON_EXPORT, ON_FAST_ACCESS_DRAG_OVER, ON_FIELD_CHANGE, ON_FILE_ACTION, ON_FILE_PREVIEW, ON_FILE_SEARCH, ON_FORM_CREATED, ON_FORM_RENDER_ERROR, ON_FORWARD, ON_IGNORE, ON_INDEX, ON_INDEX_CLEAR, ON_INDEX_RESULTITEM, ON_ITEM_DOUBLECLICK, ON_LAUNCH_WORKFLOW, ON_LOG, ON_LOGON, ON_MACRO, ON_NAVIGATION, ON_NAVIGATION_FOLDER, ON_NAVIGATION_FORM, ON_NAVIGATION_WEBPART, ON_NEW_ITEM, ON_NEW_SELECTED, ON_OK, ON_OPEN_INDEX_MASK, ON_OPEN_MASK, ON_OPEN_QUERY_MASK, ON_PASSWORD_EXPIRED, ON_PRINT_DOCUMENTS, ON_QUERY, ON_QUERY_FAVORITE, ON_REFRESH, ON_REFRESH_FOLDER, ON_RESET_GUI, ON_REVISION_CREATED, ON_SAVE_AND, ON_SAVE_DOC, ON_SAVE_FOLDER, ON_SCROLL_NODE, ON_SELECT_TREE_ITEM, ON_SELECTDDC, ON_SEND_MAIL_RESULTITEM, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_SUCCESS, ON_VARIABLES_AVAILABLE, ON_WF, ON_WF_COMMENT_DIALOG_CANCEL, ON_WF_COMMENT_DIALOG_OK, ON_WFCOMMENTS, ON_WFDELEGATE, ON_WFFORWARD, ON_WFFORWARD1, ON_WFFORWARD2, ON_WFFORWARD3, ON_WFFORWARD4, ON_WFFORWARD5, ON_WFHISTORY, ON_WFPUTBACK, ON_WFREMINDER, ON_WFTAKE, ON_WORKFLOW_ACTION, ON_WORKFLOW_COMMENT

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
TristateField() Constructor.
TristateField(com.saperion.ngc.iform.xml.EditFieldType type, com.saperion.ngc.iform.xml.PosType panePos) Constructor.
TristateField(String label) Constructor.

Method Summary

Modifier and Type	Method and Description
void	attachClientScripts(com.saperion.ngc.iform.xml.EditFieldType field) Attaches client side scripts after page load
void	attachScripts(com.saperion.ngc.iform.xml.EditFieldType field, EventChildHandler provider, org.zkoss.zk.ui.Page newPage) Attaches client and server side scripts after page load
void	attachServerScripts(com.saperion.ngc.iform.xml.EditFieldType field, EventChildHandler provider, org.zkoss.zk.ui.Page newPage) Attaches server side scripts after page load
void	clear() Clears the value(s) of this field.
void	clearErrorMessage() Removes the validation error message if present.
void	detachScripts(com.saperion.ngc.iform.xml.EditFieldType field, org.zkoss.zk.ui.Page page)
void	doChangeValue(org.zkoss.zk.ui.event.Event event)
String	generateUUID()
long	getColorError()
long	getColorOk()
int	getConditionField()
com.saperion.ngc.iform.xml.EditFieldType	getEditField() Returns the EditFieldType defining the properties of this field.
IntelligentField.ElementType	getElementType() Returns the type of this element.
short	getEnableMaximize()
Set<org.zkoss.zk.ui.Component>	getEventtarget(String eventName) Reads the event target for the given event name, if set or the root element.
String	getFieldName() Returns the name of the field.
String	getFName()
com.saperion.ngc.iform.xml.FontType	getFont()
String	getLimit() Returns the limit of this field (upper, lower or both).
long	getListVersion()
com.saperion.ngc.iform.xml.OverrideKindType	getMandatory()
IntelligentFormView	getParentForm() Returns the parent form or null if this field is not part of a form.
com.saperion.ngc.iform.xml.PosType	getPos()
int	getResFieldCnt()
int	getResStyle()
FieldResultBean	getResultBean() Returns a bean containing the current value, type, name and limit of this field.
int	getTabindex()
short	getVarDataType()
int	getWxCombo()
int	getWyCombo()
int	getXCombo()
boolean	isAllowInactiveLookup()
boolean	isAutoComplete()
boolean	isBEnabled()
boolean	isBPersistent()
boolean	isChanged() Returns true if the value of this field was changed.
boolean	isContentValid() Performs a validation and returns true, if the content is valid.
boolean	isEmpty()
boolean	isFieldInactive() Returns the fieldInactive parameter.
boolean	isHideButtons()
boolean	isIsVar()
boolean	isNoLocalize() Returns the noLocalize parameter.
boolean	isPersistVar()
boolean	isReadonly() gets the readonly state of this field.
boolean	isRestrictCursor()
boolean	isSaveLayout()
boolean	isUseCalendar()
void	onCancelEdit(org.zkoss.zk.ui.event.Event event) Event handler for cancel edit event.
void	onIndexChange(org.zkoss.zk.ui.event.Event event) Event handler for index changes.
void	onIndexClear(org.zkoss.zk.ui.event.Event event) Event handler for index clear.
void	onOK(org.zkoss.zk.ui.event.Event event) On OK event handler.
void	onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
void	onPageDetached(org.zkoss.zk.ui.Page page)
void	onVariablesAvailable(org.zkoss.zk.ui.event.Event event) Event handler for variablesAvailableEvent.
void	postFieldChangeEvent(ResultProperty property) Posts a FieldChangeEvent.
void	postFormButtonEvent(ButtonInfo info) Posts a FormButtonEvent.
void	setAlign(com.saperion.ngc.iform.xml.AlignType value)
void	setAllowInactiveLookup(boolean value)
void	setAutoComplete(boolean value)
void	setBEnabled(boolean value)
void	setBPersistent(boolean value)
void	setChangedImplicitly() Sets the changed-property of this field to true.
void	setChangedImplicitly(boolean fireChangedEvent) Sets the changed-property of this field to true.
void	setColorError(long value)
void	setColorOk(long value)
void	setConditionField(int value)
void	setDefaultValue(String valueAsString) Sets the default value.
void	setDisabled(boolean disabled) Set disabled state.
void	setEnableMaximize(short value)
void	setEventOnOk(ButtonInfo.EventType type) Starts event handling on enter key.
void	setEventtarget(org.zkoss.zk.ui.Component comp, String eventName) Set the event target.
void	setFieldInactive(boolean inactive) Sets the fieldInactive parameter.
void	setFieldName(String name) Sets the name of the field.
void	setFName(String value)
void	setFont(com.saperion.ngc.iform.xml.FontType value)
void	setHideButtons(boolean value)
void	setIsVar(boolean value)
void	setLimit(String value) Sets the limit type.
void	setListVersion(long value)
void	setMandatory(com.saperion.ngc.iform.xml.OverrideKindType value)
void	setNoLocalize(boolean noLocalize) Sets the noLocalize parameter.
void	setPersistVar(boolean value)
void	setPos(com.saperion.ngc.iform.xml.PosType value)
void	setReadonly(boolean readonly) Sets the readonle state of this field.
void	setResFieldCnt(int value)
void	setResStyle(int value)
void	setRestrictCursor(boolean value)
void	setSaveLayout(boolean value)
void	setTabindex(int index) This method is not supported in TristateField and does nothing.
void	setUseCalendar(boolean value)
void	setValue(com.saperion.intf.SaPropertyValue value) Sets the value of this field.
void	setValueImplicitly(com.saperion.intf.SaPropertyValue val) Sets the value of this field and sets the changed-property of this field to true.
void	setValueImplicitly(com.saperion.intf.SaPropertyValue value, boolean fireChangedEvent) Sets the value of this field and sets the changed-property of this field to true.
void	setVarDataType(short value)
void	setWxCombo(int value)
void	setWyCombo(int value)
void	setXCombo(int value)
String	toString()
void	updateAttribute(String attr, Object value) Performs a smartUpdate on the specified attribute.
void	validate() Starts validation of the field.

Methods inherited from class com.saperion.ngc.iform.tristate.Tristate

getValue, isChecked, isDisabled, service, setChecked, setStringValue, setValue

Methods inherited from class org.zkoss.zul.Box

getAlign, getHeights, getOrient, getPack, getSpacing, getWidths, getZclass, isHorizontal, isSizedByContent, isVertical, renderProperties, setAlign, setHeights, setOrient, setPack, setSizedByContent, setSpacing, setWidths

Methods inherited from class org.zkoss.zul.impl.XulElement

clone, getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onChildRemoved, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Methods inherited from interface org.zkoss.zul.api.Box

getAlign, getHeights, getOrient, getPack, getSpacing, getWidths, isHorizontal, isSizedByContent, isVertical, setAlign, setHeights, setOrient, setPack, setSizedByContent, setSpacing, setWidths

Constructor Detail

TristateField

public TristateField(com.saperion.ngc.iform.xml.EditFieldType type,
                     com.saperion.ngc.iform.xml.PosType panePos)

Constructor.

Parameters:

type - Type

panePos - Pane position

TristateField

public TristateField()

Constructor.

TristateField

public TristateField(String label)

Constructor.

Parameters:

label - Label

Method Detail

onOK

public void onOK(org.zkoss.zk.ui.event.Event event)

On OK event handler.

Parameters:

event - Event

onPageAttached

public void onPageAttached(org.zkoss.zk.ui.Page newpage,
                           org.zkoss.zk.ui.Page oldpage)

Specified by:

onPageAttached in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onPageAttached in class org.zkoss.zk.ui.AbstractComponent

See Also:

AbstractComponent.onPageAttached(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Page)

onPageDetached

public void onPageDetached(org.zkoss.zk.ui.Page page)

Specified by:

onPageDetached in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onPageDetached in class org.zkoss.zk.ui.AbstractComponent

See Also:

AbstractComponent.onPageDetached(org.zkoss.zk.ui.Page)

onIndexChange

public void onIndexChange(org.zkoss.zk.ui.event.Event event)

Event handler for index changes.

Specified by:

onIndexChange in interface IntelligentField

Parameters:

event - Event

See Also:

IntelligentField.onIndexChange(org.zkoss.zk.ui.event.Event)

onVariablesAvailable

public void onVariablesAvailable(org.zkoss.zk.ui.event.Event event)

Event handler for variablesAvailableEvent. The event-object sent does not contain data. To retrieve variables, use IntelligentFormView.getIndexMaskDocument().

Specified by:

onVariablesAvailable in interface IntelligentField

Parameters:

event - Event

See Also:

IntelligentField.onVariablesAvailable(org.zkoss.zk.ui.event.Event)

onCancelEdit

public void onCancelEdit(org.zkoss.zk.ui.event.Event event)

Event handler for cancel edit event.

Specified by:

onCancelEdit in interface IntelligentField

Parameters:

event - event

See Also:

IntelligentField.onCancelEdit(org.zkoss.zk.ui.event.Event)

setValue

public void setValue(com.saperion.intf.SaPropertyValue value)

Sets the value of this field.

Specified by:

setValue in interface IntelligentField

Parameters:

value - value

See Also:

IntelligentField.setValue(com.saperion.intf.SaPropertyValue)

setValueImplicitly

public void setValueImplicitly(com.saperion.intf.SaPropertyValue val)

Sets the value of this field and sets the changed-property of this field to true.

Specified by:

setValueImplicitly in interface IntelligentField

Parameters:

val - value

See Also:

IntelligentField.setValueImplicitly(com.saperion.intf.SaPropertyValue)

setValueImplicitly

public void setValueImplicitly(com.saperion.intf.SaPropertyValue value,
                               boolean fireChangedEvent)

Sets the value of this field and sets the changed-property of this field to true.

Specified by:

setValueImplicitly in interface IntelligentField

Parameters:

value - value

fireChangedEvent - if true, a Events.ON_CHANGE event will be fired after the value was set

See Also:

IntelligentField.setValueImplicitly(com.saperion.intf.SaPropertyValue, boolean)

onIndexClear

public void onIndexClear(org.zkoss.zk.ui.event.Event event)

Event handler for index clear.

Specified by:

onIndexClear in interface IntelligentField

Parameters:

event - Event

See Also:

IntelligentField.onIndexClear(org.zkoss.zk.ui.event.Event)

isChanged

public boolean isChanged()

Returns true if the value of this field was changed.

Specified by:

isChanged in interface IntelligentField

Returns:

Value is changed.

See Also:

IntelligentField.isChanged()

setEventOnOk

public void setEventOnOk(ButtonInfo.EventType type)

Starts event handling on enter key.

Specified by:

setEventOnOk in interface IntelligentField

Parameters:

type - Event type

See Also:

IntelligentField.setEventOnOk(com.saperion.ngc.iform.button.ButtonInfo.EventType)

doChangeValue

public void doChangeValue(org.zkoss.zk.ui.event.Event event)

Specified by:

doChangeValue in interface IntelligentField

Parameters:

event - Event

See Also:

IntelligentField.doChangeValue(org.zkoss.zk.ui.event.Event)

getColorError

public long getColorError()

Returns:

Value

See Also:

EditFieldType.getColorError()

getColorOk

public long getColorOk()

Returns:

Value

See Also:

EditFieldType.getColorOk()

getConditionField

public int getConditionField()

Returns:

Value

See Also:

EditFieldType.getConditionField()

getEnableMaximize

public short getEnableMaximize()

Returns:

Value

See Also:

EditFieldType.getEnableMaximize()

getFName

public String getFName()

Returns:

Value

See Also:

EditFieldType.getFName()

getFont

public com.saperion.ngc.iform.xml.FontType getFont()

Returns:

Value

See Also:

EditFieldType.getFont()

getLimit

public String getLimit()

Description copied from interface: IntelligentField

Returns the limit of this field (upper, lower or both).

Specified by:

getLimit in interface IntelligentField

Returns:

Value

See Also:

EditFieldType.getLimit()

getListVersion

public long getListVersion()

Returns:

Value

See Also:

EditFieldType.getListVersion()

getMandatory

public com.saperion.ngc.iform.xml.OverrideKindType getMandatory()

Returns:

Value

See Also:

EditFieldType.getMandatory()

getPos

public com.saperion.ngc.iform.xml.PosType getPos()

Returns:

Value

See Also:

EditFieldType.getPos()

getResFieldCnt

public int getResFieldCnt()

Returns:

Value

See Also:

EditFieldType.getResFieldCnt()

getResStyle

public int getResStyle()

Returns:

Value

See Also:

EditFieldType.getResStyle()

getVarDataType

public short getVarDataType()

Returns:

Value

See Also:

EditFieldType.getVarDataType()

getWxCombo

public int getWxCombo()

Returns:

Value

See Also:

EditFieldType.getWxCombo()

getWyCombo

public int getWyCombo()

Returns:

Value

See Also:

EditFieldType.getWyCombo()

getXCombo

public int getXCombo()

Returns:

Value

See Also:

EditFieldType.getXCombo()

isAllowInactiveLookup

public boolean isAllowInactiveLookup()

Returns:

Value

See Also:

EditFieldType.isAllowInactiveLookup()

isAutoComplete

public boolean isAutoComplete()

Returns:

Value

See Also:

EditFieldType.isAutoComplete()

isBEnabled

public boolean isBEnabled()

Returns:

Value

See Also:

EditFieldType.isBEnabled()

isBPersistent

public boolean isBPersistent()

Returns:

Value

See Also:

EditFieldType.isBPersistent()

isHideButtons

public boolean isHideButtons()

Returns:

Value

See Also:

EditFieldType.isHideButtons()

isIsVar

public boolean isIsVar()

Returns:

Value

See Also:

EditFieldType.isIsVar()

isPersistVar

public boolean isPersistVar()

Returns:

Value

See Also:

EditFieldType.isPersistVar()

isRestrictCursor

public boolean isRestrictCursor()

Returns:

Value

See Also:

EditFieldType.isRestrictCursor()

isSaveLayout

public boolean isSaveLayout()

Returns:

Value

See Also:

EditFieldType.isSaveLayout()

isUseCalendar

public boolean isUseCalendar()

Returns:

Value

See Also:

EditFieldType.isUseCalendar()

setAlign

public void setAlign(com.saperion.ngc.iform.xml.AlignType value)

Parameters:

value - Value

See Also:

EditFieldType.setAlign(com.saperion.ngc.iform.xml.AlignType)

setAllowInactiveLookup

public void setAllowInactiveLookup(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setAllowInactiveLookup(boolean)

setAutoComplete

public void setAutoComplete(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setAutoComplete(boolean)

setBEnabled

public void setBEnabled(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setBEnabled(boolean)

setBPersistent

public void setBPersistent(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setBPersistent(boolean)

setColorError

public void setColorError(long value)

Parameters:

value - Value

See Also:

EditFieldType.setColorError(long)

setColorOk

public void setColorOk(long value)

Parameters:

value - Value

See Also:

EditFieldType.setColorOk(long)

setConditionField

public void setConditionField(int value)

Parameters:

value - Value

See Also:

EditFieldType.setConditionField(int)

setEnableMaximize

public void setEnableMaximize(short value)

Parameters:

value - Value

See Also:

EditFieldType.setEnableMaximize(short)

setFName

public void setFName(String value)

Parameters:

value - Value

See Also:

EditFieldType.setFName(java.lang.String)

setFont

public void setFont(com.saperion.ngc.iform.xml.FontType value)

Parameters:

value - Value

See Also:

EditFieldType.setFont(com.saperion.ngc.iform.xml.FontType)

setHideButtons

public void setHideButtons(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setHideButtons(boolean)

setIsVar

public void setIsVar(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setIsVar(boolean)

setLimit

public void setLimit(String value)

Description copied from interface: IntelligentField

Sets the limit type. Possible values are: 'lower', 'upper', 'both'.

Specified by:

setLimit in interface IntelligentField

Parameters:

value - Value

See Also:

EditFieldType.setLimit(com.saperion.ngc.iform.xml.LimitType)

setListVersion

public void setListVersion(long value)

Parameters:

value - Value

See Also:

EditFieldType.setListVersion(long)

setMandatory

public void setMandatory(com.saperion.ngc.iform.xml.OverrideKindType value)

Parameters:

value - Value

See Also:

EditFieldType.setMandatory(com.saperion.ngc.iform.xml.OverrideKindType)

setPersistVar

public void setPersistVar(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setPersistVar(boolean)

setPos

public void setPos(com.saperion.ngc.iform.xml.PosType value)

Parameters:

value - Value

See Also:

EditFieldType.setPos(com.saperion.ngc.iform.xml.PosType)

setResFieldCnt

public void setResFieldCnt(int value)

Parameters:

value - Value

See Also:

EditFieldType.setResFieldCnt(int)

setResStyle

public void setResStyle(int value)

Parameters:

value - Value

See Also:

EditFieldType.setResStyle(int)

setRestrictCursor

public void setRestrictCursor(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setRestrictCursor(boolean)

setSaveLayout

public void setSaveLayout(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setSaveLayout(boolean)

setUseCalendar

public void setUseCalendar(boolean value)

Parameters:

value - Value

See Also:

EditFieldType.setUseCalendar(boolean)

setVarDataType

public void setVarDataType(short value)

Parameters:

value - Value

See Also:

EditFieldType.setVarDataType(short)

setWxCombo

public void setWxCombo(int value)

Parameters:

value - Value

See Also:

EditFieldType.setWxCombo(int)

setWyCombo

public void setWyCombo(int value)

Parameters:

value - Value

See Also:

EditFieldType.setWyCombo(int)

setXCombo

public void setXCombo(int value)

Parameters:

value - Value

See Also:

EditFieldType.setXCombo(int)

getElementType

public IntelligentField.ElementType getElementType()

Returns the type of this element. The type defines the kind of data and control used for this IntelligentField. See IntelligentField.ElementType for a list of types.

Specified by:

getElementType in interface IntelligentField

Returns:

Element type

See Also:

IntelligentField.getElementType()

getResultBean

public FieldResultBean getResultBean()

Returns a bean containing the current value, type, name and limit of this field.

Specified by:

getResultBean in interface IntelligentField

Returns:

Result bean

See Also:

IntelligentField.getResultBean()

getEventtarget

public Set<org.zkoss.zk.ui.Component> getEventtarget(String eventName)

Reads the event target for the given event name, if set or the root element.

Specified by:

getEventtarget in interface EventChild

Parameters:

eventName - Event name or null for main target

Returns:

Set of event targets

See Also:

EventChild.getEventtarget(java.lang.String)

setEventtarget

public void setEventtarget(org.zkoss.zk.ui.Component comp,
                           String eventName)

Set the event target.

Specified by:

setEventtarget in interface EventChild

Parameters:

comp - Event target

eventName - Event name or null for main target

See Also:

EventChild.setEventtarget(org.zkoss.zk.ui.Component, java.lang.String)

postFormButtonEvent

public void postFormButtonEvent(ButtonInfo info)

Posts a FormButtonEvent.

Parameters:

info - information about the button pressed

See Also:

EventChildHandler.postFormButtonEvent(com.saperion.ngc.iform.button.ButtonInfo)

postFieldChangeEvent

public void postFieldChangeEvent(ResultProperty property)

Posts a FieldChangeEvent.

Parameters:

property - the property that was changed

See Also:

EventChildHandler.postFieldChangeEvent(com.saperion.ngc.model.resultset.ResultProperty)

getFieldName

public String getFieldName()

Returns the name of the field.

Specified by:

getFieldName in interface IntelligentField

Returns:

Field name

See Also:

IntelligentField.getFieldName()

isContentValid

public boolean isContentValid()

Performs a validation and returns true, if the content is valid.

Specified by:

isContentValid in interface IntelligentField

Returns:

Field content is valid.

See Also:

IntelligentField.isContentValid()

getEditField

public com.saperion.ngc.iform.xml.EditFieldType getEditField()

Returns the EditFieldType defining the properties of this field.

Specified by:

getEditField in interface IntelligentField

Returns:

the edit field

See Also:

IntelligentField.getEditField()

setDefaultValue

public void setDefaultValue(String valueAsString)

Sets the default value.

Specified by:

setDefaultValue in interface IntelligentField

Parameters:

valueAsString - string representation of value

See Also:

IntelligentField.setDefaultValue(java.lang.String)

setFieldInactive

public void setFieldInactive(boolean inactive)

Sets the fieldInactive parameter. Same as setReadonly(inactive).

Specified by:

setFieldInactive in interface IntelligentField

Parameters:

inactive - value

See Also:

IntelligentField.setFieldInactive(boolean)

isFieldInactive

public boolean isFieldInactive()

Returns the fieldInactive parameter.

Specified by:

isFieldInactive in interface IntelligentField

Returns:

fieldInactive

See Also:

IntelligentField.isFieldInactive()

setDisabled

public void setDisabled(boolean disabled)

Set disabled state.

Specified by:

setDisabled in interface IntelligentField

Overrides:

setDisabled in class Tristate

Parameters:

disabled - value

See Also:

InputElement.setDisabled(boolean)

setReadonly

public void setReadonly(boolean readonly)

Sets the readonle state of this field.

Specified by:

setReadonly in interface IntelligentField

Parameters:

readonly - readonly

See Also:

IntelligentField.setReadonly(boolean)

isReadonly

public boolean isReadonly()

gets the readonly state of this field.

Specified by:

isReadonly in interface IntelligentField

See Also:

InputElement.setReadonly(boolean)

setFieldName

public void setFieldName(String name)

Sets the name of the field. The name is required to be the same as in the database table representing the DDC used.

Specified by:

setFieldName in interface IntelligentField

Parameters:

name - field name

See Also:

IntelligentField.setFieldName(java.lang.String)

validate

public void validate()

Starts validation of the field.

Specified by:

validate in interface IntelligentField

See Also:

IntelligentField.validate()

clearErrorMessage

public void clearErrorMessage()

Removes the validation error message if present.

Specified by:

clearErrorMessage in interface IntelligentField

See Also:

IntelligentField.clearErrorMessage()

getParentForm

public IntelligentFormView getParentForm()

Returns the parent form or null if this field is not part of a form.

Specified by:

getParentForm in interface IntelligentField

Returns:

parent form or null

See Also:

IntelligentField.getParentForm()

setChangedImplicitly

public void setChangedImplicitly()

Sets the changed-property of this field to true.

Specified by:

setChangedImplicitly in interface IntelligentField

See Also:

IntelligentField.setChangedImplicitly()

setChangedImplicitly

public void setChangedImplicitly(boolean fireChangedEvent)

Sets the changed-property of this field to true.

Specified by:

setChangedImplicitly in interface IntelligentField

Parameters:

fireChangedEvent - if true, a Events.ON_CHANGE event will be fired

See Also:

IntelligentField.setChangedImplicitly(boolean)

updateAttribute

public void updateAttribute(String attr,
                            Object value)

Performs a smartUpdate on the specified attribute.

Specified by:

updateAttribute in interface IntelligentField

Parameters:

attr - attribute name

value - attribute value

See Also:

IntelligentField.updateAttribute(java.lang.String, java.lang.Object)

isNoLocalize

public boolean isNoLocalize()

Description copied from interface: Localized

Returns the noLocalize parameter.

Specified by:

isNoLocalize in interface Localized

Returns:

noLocalize

setNoLocalize

public void setNoLocalize(boolean noLocalize)

Description copied from interface: Localized

Sets the noLocalize parameter.

Specified by:

setNoLocalize in interface Localized

Parameters:

noLocalize - value

generateUUID

public String generateUUID()

Specified by:

generateUUID in interface Identifiable

Returns:

the generated uuid for the DOM tree

toString

public String toString()

Overrides:

toString in class org.zkoss.zk.ui.AbstractComponent

See Also:

AbstractComponent.toString()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IntelligentField

Returns:

true if the field's value is empty.

See Also:

IntelligentField.isEmpty()

setTabindex

public void setTabindex(int index)

This method is not supported in TristateField and does nothing.

Specified by:

setTabindex in interface IntelligentField

Parameters:

index - tabindex

See Also:

InputElement.setTabindex(int)

getTabindex

public int getTabindex()

Specified by:

getTabindex in interface IntelligentField

Returns:

the tabindex of this field.

See Also:

InputElement.getTabindex()

clear

public void clear()

Description copied from interface: IntelligentField

Clears the value(s) of this field.

Specified by:

clear in interface IntelligentField

attachScripts

public void attachScripts(com.saperion.ngc.iform.xml.EditFieldType field,
                          EventChildHandler provider,
                          org.zkoss.zk.ui.Page newPage)

Description copied from interface: IntelligentField

Attaches client and server side scripts after page load

Specified by:

attachScripts in interface IntelligentField

Parameters:

field - The field to attach the code to.

provider - Instance of EventChildHandler

newPage - The page on which the field is attached.

attachClientScripts

public void attachClientScripts(com.saperion.ngc.iform.xml.EditFieldType field)

Description copied from interface: IntelligentField

Attaches client side scripts after page load

Specified by:

attachClientScripts in interface IntelligentField

Parameters:

field - The field to attach the code to.

attachServerScripts

public void attachServerScripts(com.saperion.ngc.iform.xml.EditFieldType field,
                                EventChildHandler provider,
                                org.zkoss.zk.ui.Page newPage)

Description copied from interface: IntelligentField

Attaches server side scripts after page load

Specified by:

attachServerScripts in interface IntelligentField

Parameters:

field - The field to attach the code to.

provider - Instance of EventChildHandler

newPage - The page on which the field is attached.

detachScripts

public void detachScripts(com.saperion.ngc.iform.xml.EditFieldType field,
                          org.zkoss.zk.ui.Page page)

Specified by:

detachScripts in interface IntelligentField