psdi.webclient.components

Class ToggleImage

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ComponentInstance

psdi.webclient.system.controller.DynamicAttributeComponent

psdi.webclient.system.controller.BoundComponentInstance

psdi.webclient.components.ToggleImage

All Implemented Interfaces:

java.lang.Cloneable, DataBeanListener

Direct Known Subclasses:

TableToggleDetails, TableToggleImage

public class ToggleImage
extends BoundComponentInstance

Designed to allow an image to toggle based on a check method. Method will be called via reflection in the component and then the control until one handles it.

Author:

Brian_Ragusa

Property Summary

Properties inherited from class psdi.webclient.system.controller.ComponentInstance

hiddenByProperty

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	lastState
java.util.Hashtable<java.lang.String,java.lang.String>	lastStates
java.lang.String	source
java.lang.String	state
java.util.Hashtable<java.lang.String,java.lang.String>	states

Fields inherited from class psdi.webclient.system.controller.BoundComponentInstance

ATTRIBUTE_NAME, BAD_BINDING_CSS, bound, BOUND_LABEL, COLUMN_NAME, CSS_CLASS, DATA_ATTRIBUTE, DEFAULT_LABEL, DOMAIN, ENTITY_NAME, EVENT_PRIORITY, FIELD_LABEL, HAS_LONG_DESCRIPTION, HIDE_LABEL, ID, INT_TYPE, INTERNAL, INVALID_BINDING, IS_NUMERIC, IS_PERSISTENT, KEY, LABEL, LABELFORMAT, LENGTH, LONGDESC_ATTRIBUTE_SUFFIX, OBJECT_NAME, PRIORITY_DATATYPE, PRIORITY_FLUSH, PRIORITY_VALIDATION, QUERY, REMARKS, SCALE, SIZE, SYNCHRONOUS, TAKESVALUE, TITLE, TRUELENGTH, TYPEAHEADATTRS

Fields inherited from class psdi.webclient.system.controller.DynamicAttributeComponent

CLASSSPECVALUEATTRIBUTES, DYNAMICATTRIBUTE

Fields inherited from class psdi.webclient.system.controller.ComponentInstance

CLICKABLE_OFF, CLICKABLE_ON, CONTAINER_ERROR, CONTAINER_ERROR_IMAGE, CONTAINER_WARNING, CONTAINER_WARNING_IMAGE, LOG_CATEGORY, NOT_CLICKABLE, popDefinition

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
ToggleImage()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canChangeRowFocus() Clicking on toggle image component should also change the focus on the table row if not running in asynchronous mode.
int	getClickState() Returns whether or not this item is clickable.
java.lang.String	getLabel() This method returns the current label based on the method defined in tooltip property
java.lang.Object	getLastState()
java.lang.String	getMessage() This method returns the current message based on the method defined in tooltip property
java.lang.String	getRowNum()
java.lang.String	getSource() This method builds the propertyname for use in retrieving the correct image, based on the current state.
java.lang.Object	getState()
int	render() Needed to override this method to cache original values for data, readonly, required and applink
boolean	stateChanged()
java.lang.String	updateState(java.lang.String methodName)

Methods inherited from class psdi.webclient.system.controller.BoundComponentInstance

addAttributeError, addSetValueError, applink, cleanup, clearErrors, createChangedPropList, dataRestrictionCheck, datelookup, decrement, exceptionhandled, getApplink, getBoolean, getCurrentError, getDataBean, getDataType, getDataValueInError, getErrorForRow, getExcDialogIcon, getExceptionType, getFieldInfo, getHighestErrorLevel, getInputMode, getInputModeWithoutPasswordPrefix, getLinkBack, getLongDescription, getLookupName, getQbeNameWithPrepend, getRenderIdForAutoFill, getString, getWarningList, getWarningMessages, hasChanged, hasDataChanged, hasLongDescChanged, hasLongDescription, hasReadonlyChanged, hasRequiredChanged, hasWarnings, increment, initialize, instantiatedatasrc, isDataValid, isDefault, isMasked, isOnCurrentRow, isPasswordField, isQuery, isReadOnly, isRequired, isRevert, isRowDeleted, isSmartFillEnabled, popexception, processAsyncYesNoCancel, processEdit, processIgnoreWarning, processProfile, processRevert, readOnlyCheck, removeCurrentError, resetIsRevert, retryErrorValues, selectvalue, setBoundAsRequired, setcurrentdate, setDataValid, setDataValueInError, updateCachedDataValue, useMaxLength

Methods inherited from class psdi.webclient.system.controller.DynamicAttributeComponent

click, dataChangedEvent, getProperty, hasAnyPropertyChanged, needsRender, resetAttribute, structureChangedEvent

Methods inherited from class psdi.webclient.system.controller.ComponentInstance

action, broadcastEvent, clearChangedFlag, clearUIUpdates, controlPropertyChanged, fetchtooltip, findComponentByDescriptorId, findProperty, formatLabel, formatLabel, getChildrenDesignOnly, getComponentContainerId, getControl, getCssClass, getCurrent, getCurrentUpdates, getDesignerSelected, getErrorInfo, getFocusRenderId, getId, getId, getIdWithoutRow, getLabelForRenderId, getLabelledByRenderId, getLinkedComponentInstance, getMenuType, getOriginalProperty, getRenderId, getUpdatedAttributes, getUpdatedStyles, hasChildren, hasComponents, hasLocalProperty, hasMaskedChanged, hasUnappliedUIUpdates, hiddenByProp, hiddenByProperty, isAsyncEnabled, isChild, isComponent, isDefaultRender, isDisabled, isHoversActive, isIncluded, isOnTableFilterRow, isOnTableRow, isOnTableTitleRow, isVisible, query, renderChildComponents, renderChildrenControls, rerendering, setChangedFlag, setChangedFlag, setComponentContainerId, setControl, setFocus, setIsHoversActive, setLabelFormat, showMenu, showMenubarMenu, signout, skipRender, updateAttribute, updateStyle, updateStyle

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getSafeId, getString, getType, getWebClientSession, handleEvent, handleEvent, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

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

Field Detail

state

public java.lang.String state

lastState

public java.lang.String lastState

source

public java.lang.String source

states

public java.util.Hashtable<java.lang.String,java.lang.String> states

lastStates

public java.util.Hashtable<java.lang.String,java.lang.String> lastStates

Constructor Detail

ToggleImage

public ToggleImage()

Method Detail

getRowNum

public java.lang.String getRowNum()

Overrides:

getRowNum in class BaseInstance

getState

public java.lang.Object getState()

getLastState

public java.lang.Object getLastState()

updateState

public java.lang.String updateState(java.lang.String methodName)

Returns:

String - current state of image

stateChanged

public boolean stateChanged()

getSource

public java.lang.String getSource()

This method builds the propertyname for use in retrieving the correct image, based on the current state.

Returns:

String - current image

getMessage

public java.lang.String getMessage()

This method returns the current message based on the method defined in tooltip property

Returns:

String - tooltip

getLabel

public java.lang.String getLabel()

This method returns the current label based on the method defined in tooltip property

Returns:

String - tooltip

render

public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException

Description copied from class: BoundComponentInstance

Needed to override this method to cache original values for data, readonly, required and applink

Overrides:

render in class BoundComponentInstance

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

See Also:

ComponentInstance.render()

getClickState

public int getClickState()

Description copied from class: ComponentInstance

Returns whether or not this item is clickable. Uses clickablesate property on the component.

• NOT_CLICKABLE Does not have an MXEVENT
• CLICKABLE_OFF Has MXEVENT, but cannot be clicked now
• CLICKABLE_ON Has MXEVENT and can be clicked now

Overrides:

getClickState in class ComponentInstance

Returns:

the state

canChangeRowFocus

public boolean canChangeRowFocus()

Clicking on toggle image component should also change the focus on the table row if not running in asynchronous mode.

Overrides:

canChangeRowFocus in class ComponentInstance

Returns: