project35.desktopDeployment
Class DataFieldView

java.lang.Object
  project35.desktopDeployment.DataFieldView

All Implemented Interfaces:

ContextHelpItem

Direct Known Subclasses:

EditFieldView, ListFieldView

public abstract class DataFieldView
extends Object
implements ContextHelpItem

Describes basic aspects of a field view including context sensitive help and whether field should indicate a required or optional model component. this class complements project35.model.DataFieldModel

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Field Summary

protected JComponent	activityArea
protected Collator	collator
protected DataFieldModel	dataFieldModel
protected Font	font
protected JLabel	label
protected String	name
protected Project35FormContext	project35FormContext
protected Project35UIFactory	project35UIFactory

Constructor Summary

DataFieldView()

Method Summary

void	changeFont(Font font)
void	deregisterToolTipComponents()
void	enableContextHelp(boolean enableContextHelp) turns context help sensitivity on or off
Component	getActivityArea()
Font	getFont()
URL	getHelpLink()
JLabel	getLabel()
String	getName()
boolean	hasFocus()
void	indicateErrors(boolean indicateErrors)
void	initialise(DataFieldModel dataFieldModel, Project35FormContext project35FormContext) sets the model used by the view.
boolean	isContextHelpEnabled()
boolean	isRequiredField()
protected void	setActivityArea(JComponent activityArea) sets the activity area of the field.
void	setHelpLink(URL helpLink) sets the context help for this field
void	setName(String name) sets the name of the field.
void	setRequiredField(boolean isRequiredField) sets whether the field is required or optional.

Methods inherited from class java.lang.Object

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

Field Detail

label

protected JLabel label

font

protected Font font

name

protected String name

activityArea

protected JComponent activityArea

dataFieldModel

protected DataFieldModel dataFieldModel

project35FormContext

protected Project35FormContext project35FormContext

project35UIFactory

protected Project35UIFactory project35UIFactory

collator

protected Collator collator

Constructor Detail

DataFieldView

public DataFieldView()

Method Detail

initialise

public void initialise(DataFieldModel dataFieldModel,
                       Project35FormContext project35FormContext)

sets the model used by the view. Called by subclasses to take care of things like setting context sensitive help links and to indicate whether field is required or optional.

Parameters:

dataFieldModel - the model used by the view

getLabel

public JLabel getLabel()

getActivityArea

public Component getActivityArea()

getName

public String getName()

getHelpLink

public URL getHelpLink()

Specified by:

getHelpLink in interface ContextHelpItem

Returns:

the URL for the HTML help page associated with the item

hasFocus

public boolean hasFocus()

isRequiredField

public boolean isRequiredField()

getFont

public Font getFont()

isContextHelpEnabled

public boolean isContextHelpEnabled()

Specified by:

isContextHelpEnabled in interface ContextHelpItem

Returns:

whether context help mode is currently activated for item

indicateErrors

public void indicateErrors(boolean indicateErrors)

deregisterToolTipComponents

public void deregisterToolTipComponents()

setRequiredField

public void setRequiredField(boolean isRequiredField)

sets whether the field is required or optional. in the views required fields have bold print labels. Labels for optional fields appear in plain text

Parameters:

isRequiredField - true if the field is required; false if the field is optional

setActivityArea

protected void setActivityArea(JComponent activityArea)

sets the activity area of the field. This can be many things such as a text field, a JList, a panel of radio buttons or a combination box

Parameters:

activityArea - the part of the field that receives data entry.

setHelpLink

public void setHelpLink(URL helpLink)

sets the context help for this field

Specified by:

setHelpLink in interface ContextHelpItem

Parameters:

helpLink - the URL that provides information about a model field

setName

public void setName(String name)

sets the name of the field.

Parameters:

name - the name of the field

enableContextHelp

public void enableContextHelp(boolean enableContextHelp)

turns context help sensitivity on or off

Specified by:

enableContextHelp in interface ContextHelpItem

Parameters:

enableContextHelp - true if context help is on; otherwise false

changeFont

public void changeFont(Font font)