SignDataField (ontimize-core 5.6.0 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.ontimize.gui.field.SignDataField

All Implemented Interfaces:

AccessForm, DataComponent, FormComponent, IdentifiedElement, Internationalization, SecureElement, ValueChangeDataComponent, ImageObserver, MenuContainer, Serializable, Accessible
```
public class SignDataField
extends JPanel
implements DataComponent, AccessForm, ValueChangeDataComponent
```
Class to implement a component for signature introduction. It is formed by a label (which shows the title), a SignLabel (JLabel which stores the sign) and a JButton to clean the signature.

Author:

Imatia Innovation

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SignDataField.SignLabel
Class to create the signature panel and paints the signature.
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`SignDataField.SignLabel` Class to create the signature panel and paints the signature.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTR` The attribute key.
`protected Object`	`attribute` The reference to attribute.
`static String`	`BOTTOM` The key for bottom alignment.
`protected Object`	`bufferedSign` Object to save the bufferedSignImage
`protected ResourceBundle`	`bundle` The reference for resources file.
`protected byte[]`	`bytesImage` Object to save the signature bytes array
`protected JButton`	`dataClean` The reference to JButton "Clean" component.
`protected SignDataField.SignLabel`	`dataField` The reference to sign component.
`protected JLabel`	`dataLabel` The reference to label.
`static int`	`DEFAULT_PARENT_MARGIN` The default parent margin.
`static String`	`ENABLED` The enabled key.
`protected boolean`	`enabledXML` The reference for enabled the component (still visible).
`protected boolean`	`fireValueEvents` Notify the value change events.
`protected String`	`labelPosition` The label position.
`static String`	`LABELPOSITION` The key to specify the label position.
`protected String`	`labelText` The reference for text label.
`protected boolean`	`labelView` The label view.
`static String`	`LABELVISIBILITY` The key to specify the label visibility.
`static String`	`LEFT` The key for left alignment.
`protected boolean`	`modifiable` The condition to indicate when field is editable.
`protected Form`	`parentForm` The reference to parent form.
`protected FormPermission`	`permissionEnabled` The reference to enabled permission.
`protected FormPermission`	`permissionVisible` The reference to visible permission.
`protected boolean`	`required` The condition to indicate when field is required.
`protected boolean`	`restricted` The reference for restricted view
`static String`	`RIGHT` The key for right alignment.
`static String`	`TEXT_STR` The alternative text for attr.
`static String`	`TOP` The key for top alignment.
`protected Vector`	`valueListener` Vector for listeners.
`protected Object`	`valueSave` Object to save the signature
`protected boolean`	`visible` The reference for visualize the component
`static String`	`VISIBLE` The enabled key.

Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.ontimize.gui.field.DataComponent
COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2

Fields inherited from interface com.ontimize.gui.i18n.Internationalization
DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement
DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

SignDataField(Hashtable param)
Constructor of SignDatafield

Constructors
Constructor and Description
`SignDataField(Hashtable param)` Constructor of SignDatafield

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addValueChangeListener(ValueChangeListener l)` Adds a value change listener
`protected boolean`	`checkEnabledPermission()` Check if the user has permissions to interact with the component
`protected boolean`	`checkVisiblePermission()` Check if the user has permission to view with the component
`void`	`createDataFields()` Creates the label, signature area and clean button
`void`	`deleteData()` Delete the SignLabel
`protected void`	`fireValueChanged(Object newValue, Object oldValue, int type)` Check if the signature field has changed
`Object`	`getAttribute()` Obtain the component's attributte
`Object`	`getConstraints(LayoutManager parentLayout)` Return a new GridBagConstraints
`String`	`getLabelComponentText()` Obtains the label of SignDataField
`int`	`getSQLDataType()` Obtain the SQL Data type for SignDataField
`Vector`	`getTextsToTranslate()` Returns all the texts in the element suitable for being translated.
`Object`	`getValue()` Gets the value of SignLabel field
`void`	`init(Hashtable params)` Initialize the SignDataField component with the parameters in *.xml form
`void`	`initPermissions()` Initialize the component's permissions, setting the interaction and visibility, checking with the users permission
`boolean`	`isEmpty()` Check if the SignLabel is empty
`boolean`	`isHidden()` Check the visibility of SignDataField
`boolean`	`isModifiable()` Check if the SignDataField is modifiable
`boolean`	`isModified()` Check if the SignLabel was modified
`boolean`	`isRequired()` Check if the component is required or optional
`boolean`	`isRestricted()` Check if the component is restricted
`void`	`removeValueChangeListener(ValueChangeListener l)` Remove the value change listener
`void`	`setComponentLocale(Locale l)`
`void`	`setEnabled(boolean enabled)` Set the enabled/disabled state of the component
`void`	`setModifiable(boolean modifiable)` Set the modifiable behavior
`void`	`setParentForm(Form f)` Sets the parent form of SignDataField
`void`	`setRequired(boolean required)` Set if component is required
`void`	`setResourceBundle(ResourceBundle res)` Sets the resources bundle
`void`	`setValue(Object value)` Set the value of SignDataField
`void`	`setVisible(boolean visible)` Set the visibility state of the component
`protected void`	`update()` Updates the SignLabel

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ontimize.gui.field.FormComponent
isEnabled

Field Detail
- dataLabel
```
protected JLabel dataLabel
```
  The reference to label.
- dataField
```
protected SignDataField.SignLabel dataField
```
  The reference to sign component.
- dataClean
```
protected JButton dataClean
```
  The reference to JButton "Clean" component.
- ATTR
```
public static final String ATTR
```
  The attribute key.
  
  See Also:
  Constant Field Values
- attribute
```
protected Object attribute
```
  The reference to attribute. By default, null.
- TEXT_STR
```
public static final String TEXT_STR
```
  The alternative text for attr.
  
  See Also:
  Constant Field Values
- ENABLED
```
public static final String ENABLED
```
  The enabled key.
  
  See Also:
  Constant Field Values
- VISIBLE
```
public static final String VISIBLE
```
  The enabled key.
  
  See Also:
  Constant Field Values
- enabledXML
```
protected boolean enabledXML
```
  The reference for enabled the component (still visible).
- visible
```
protected boolean visible
```
  The reference for visualize the component
- bundle
```
protected ResourceBundle bundle
```
  The reference for resources file. By default, null.
- DEFAULT_PARENT_MARGIN
```
public static int DEFAULT_PARENT_MARGIN
```
  The default parent margin. By default, 1.
- LABELPOSITION
```
public static final String LABELPOSITION
```
  The key to specify the label position.
  
  See Also:
  Constant Field Values
- labelPosition
```
protected String labelPosition
```
  The label position. By default, top.
- LABELVISIBILITY
```
public static final String LABELVISIBILITY
```
  The key to specify the label visibility.
  
  See Also:
  Constant Field Values
- labelView
```
protected boolean labelView
```
  The label view. By default, true.
- labelText
```
protected String labelText
```
  The reference for text label. By default, null.
- LEFT
```
public static final String LEFT
```
  The key for left alignment.
  
  See Also:
  Constant Field Values
- RIGHT
```
public static final String RIGHT
```
  The key for right alignment.
  
  See Also:
  Constant Field Values
- TOP
```
public static final String TOP
```
  The key for top alignment.
  
  See Also:
  Constant Field Values
- BOTTOM
```
public static final String BOTTOM
```
  The key for bottom alignment.
  
  See Also:
  Constant Field Values
- restricted
```
protected boolean restricted
```
  The reference for restricted view
- permissionEnabled
```
protected FormPermission permissionEnabled
```
  The reference to enabled permission. By default, null.
- permissionVisible
```
protected FormPermission permissionVisible
```
  The reference to visible permission. By default, null.
- parentForm
```
protected Form parentForm
```
  The reference to parent form. By default, null.
- required
```
protected boolean required
```
  The condition to indicate when field is required. By default, false.
- modifiable
```
protected boolean modifiable
```
  The condition to indicate when field is editable. By default, true.
- bytesImage
```
protected byte[] bytesImage
```
  Object to save the signature bytes array
- bufferedSign
```
protected Object bufferedSign
```
  Object to save the bufferedSignImage
- valueSave
```
protected Object valueSave
```
  Object to save the signature
- valueListener
```
protected Vector valueListener
```
  Vector for listeners. By default, empty
- fireValueEvents
```
protected boolean fireValueEvents
```
  Notify the value change events. By default, null

Constructor Detail
- SignDataField
```
public SignDataField(Hashtable param)
              throws Exception
```
  Constructor of SignDatafield
  
  Parameters:
  params - A Hashtable which contains the initialize parameters
  
  Throws:
  
  Exception

Method Detail

setComponentLocale
```
public void setComponentLocale(Locale l)
```
Specified by:

setComponentLocale in interface Internationalization

setResourceBundle
```
public void setResourceBundle(ResourceBundle res)
```
Sets the resources bundle

Specified by:

setResourceBundle in interface Internationalization

Parameters:
res - This resource bundle contains all application translations

getTextsToTranslate
```
public Vector getTextsToTranslate()
```
Description copied from interface: Internationalization

Returns all the texts in the element suitable for being translated.

Specified by:

getTextsToTranslate in interface Internationalization

Returns:
all the texts in the element suitable for being translated.

createDataFields
```
public void createDataFields()
```
Creates the label, signature area and clean button

init

public void init(Hashtable params)
          throws Exception

Initialize the SignDataField component with the parameters in *.xml form

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr		null	yes	The reference to attribute.
enabled	yes/no	yes	no	The reference for enabled the component (still visible).
labelposition	left/right/top/bottom	top	no	The label position.
labelvisible	true/false	true	no	The label view.
text		null	no	The alternative text for attr, and a reference for the text label.
visible	yes/no	yes	no	The reference for visualize the component.

Throws:

Exception - when Exception occurs

initPermissions
```
public void initPermissions()
```
Initialize the component's permissions, setting the interaction and visibility, checking with the users permission

Specified by:

initPermissions in interface SecureElement

checkEnabledPermission
```
protected boolean checkEnabledPermission()
```
Check if the user has permissions to interact with the component

Returns:
true The user has permission to interact with the component false Otherwise

checkVisiblePermission
```
protected boolean checkVisiblePermission()
```
Check if the user has permission to view with the component

Returns:
true The user has permission to view the component false Otherwise

setEnabled
```
public void setEnabled(boolean enabled)
```
Set the enabled/disabled state of the component

Specified by:

setEnabled in interface FormComponent

Overrides:

setEnabled in class JComponent

Parameters:
enabled - the enabled condition

setVisible
```
public void setVisible(boolean visible)
```
Set the visibility state of the component

Specified by:

setVisible in interface FormComponent

Overrides:

setVisible in class JComponent

Parameters:
visible - the visibility condition

getConstraints
```
public Object getConstraints(LayoutManager parentLayout)
```
Return a new GridBagConstraints

Specified by:

getConstraints in interface FormComponent

Parameters:
parentLayout - The LayoutManager of the parentLayout

Returns:
A new GridBagContraints

isRestricted
```
public boolean isRestricted()
```
Check if the component is restricted

Specified by:

isRestricted in interface SecureElement

Returns:
true The component is restricted false The component is not restricted

getAttribute
```
public Object getAttribute()
```
Obtain the component's attributte

Specified by:

getAttribute in interface IdentifiedElement

Returns:
The component's attribute

setParentForm
```
public void setParentForm(Form f)
```
Sets the parent form of SignDataField

Specified by:

setParentForm in interface AccessForm

Parameters:
f - The parent form

getLabelComponentText
```
public String getLabelComponentText()
```
Obtains the label of SignDataField

Specified by:

getLabelComponentText in interface DataComponent

Returns:
The label of SignDataField

isModifiable
```
public boolean isModifiable()
```
Check if the SignDataField is modifiable

Specified by:

isModifiable in interface DataComponent

Returns:
true The field is modifiable

isHidden
```
public boolean isHidden()
```
Check the visibility of SignDataField

Specified by:

isHidden in interface DataComponent

Returns:
true The field is not visible false The field is visible

getSQLDataType
```
public int getSQLDataType()
```
Obtain the SQL Data type for SignDataField

Specified by:

getSQLDataType in interface DataComponent

Returns:
Type LONGVARBINARY

isRequired
```
public boolean isRequired()
```
Check if the component is required or optional

Specified by:

isRequired in interface DataComponent

Returns:
false The field is optional

getValue
```
public Object getValue()
```
Gets the value of SignLabel field

Specified by:

getValue in interface DataComponent

Returns:
A signature BytesBlock

fireValueChanged
```
protected void fireValueChanged(Object newValue,
                    Object oldValue,
                    int type)
```
Check if the signature field has changed

Parameters:
newValue - the new value of SignLabel
oldValue - the old value of SignLabel
type - Integer indicating who made the changes , if the user or application

setValue
```
public void setValue(Object value)
```
Set the value of SignDataField

Specified by:

setValue in interface DataComponent

Parameters:
value - The value to set.

update
```
protected void update()
```
Updates the SignLabel

deleteData
```
public void deleteData()
```
Delete the SignLabel

Specified by:

deleteData in interface DataComponent

isEmpty
```
public boolean isEmpty()
```
Check if the SignLabel is empty

Specified by:

isEmpty in interface DataComponent

Returns:
true The field is empty false The field is not empty

setModifiable
```
public void setModifiable(boolean modifiable)
```
Set the modifiable behavior

Specified by:

setModifiable in interface DataComponent

Parameters:
modibiable -

isModified
```
public boolean isModified()
```
Check if the SignLabel was modified

Specified by:

isModified in interface DataComponent

Returns:
trueThe component was modified falseThe component was not modified

setRequired
```
public void setRequired(boolean required)
```
Set if component is required

Specified by:

setRequired in interface DataComponent

Parameters:
required - Boolean

addValueChangeListener
```
public void addValueChangeListener(ValueChangeListener l)
```
Adds a value change listener

Specified by:

addValueChangeListener in interface ValueChangeDataComponent

Parameters:
l - The ValueChangeLitener

removeValueChangeListener
```
public void removeValueChangeListener(ValueChangeListener l)
```
Remove the value change listener

Specified by:

removeValueChangeListener in interface ValueChangeDataComponent

Parameters:
l - The ValueChangeListener

Class SignDataField

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface com.ontimize.gui.field.DataComponent

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

Fields inherited from interface com.ontimize.gui.SecureElement

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface com.ontimize.gui.field.FormComponent

Field Detail

dataLabel

dataField

dataClean

ATTR

attribute

TEXT_STR

ENABLED

VISIBLE

enabledXML

visible

bundle

DEFAULT_PARENT_MARGIN

LABELPOSITION

labelPosition

LABELVISIBILITY

labelView

labelText

LEFT

RIGHT

TOP

BOTTOM

restricted

permissionEnabled

permissionVisible

parentForm

required

modifiable

bytesImage

bufferedSign

valueSave

valueListener

fireValueEvents

Constructor Detail

SignDataField

Method Detail

setComponentLocale

setResourceBundle

getTextsToTranslate

createDataFields

init

initPermissions

checkEnabledPermission

checkVisiblePermission

setEnabled

setVisible

getConstraints

isRestricted

getAttribute

setParentForm

getLabelComponentText

isModifiable

isHidden

getSQLDataType

isRequired

getValue

fireValueChanged

setValue

update