project35.desktopDeployment
Interface ListTypeManager

All Known Implementing Classes:

MultiListTypeManager, SingleListTypeManager

public interface ListTypeManager

Interface for classes that manage the currently selected type of child subrecord for a list. In SingleTypeManager, the implementation becomes quite simple because there's only one type of child subrecord that can be created. for MultiTypeManager, the implementation has to monitor changes in the combination box that indicates the type of child subrecord to use for editing, creating or destroying a list record.

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)

Method Summary

void	changeFont(java.awt.Font font)
RecordModel	createRecordModelFromType()
void	deregisterToolTipComponents()
void	enableContextHelp(boolean enableContextHelp) controls whether context sensitive help is enabled for this UI component.
java.lang.String	getSelectedType()
java.awt.Component	getTypeArea()
java.lang.String[]	getTypes()
void	reset()
void	setFont(java.awt.Font font)
void	setListTypeListener(ListTypeListener listTypeListener) sets the listener for the type changes.
void	setModel(ListFieldModel listFieldModel) sets the list model which will contain the list of types allowed for the corresponding list

Method Detail

reset

void reset()

getSelectedType

java.lang.String getSelectedType()

Returns:

the type of child record type that will be created when end-users create a new record in the list field.

deregisterToolTipComponents

void deregisterToolTipComponents()

createRecordModelFromType

RecordModel createRecordModelFromType()

Returns:

an instance of a record of the selected subrecord type

setModel

void setModel(ListFieldModel listFieldModel)

sets the list model which will contain the list of types allowed for the corresponding list

setFont

void setFont(java.awt.Font font)

getTypeArea

java.awt.Component getTypeArea()

Returns:

the component that describes the types. in MultiTypeManager, this appears as Show: [combination box with child subrecord types]

setListTypeListener

void setListTypeListener(ListTypeListener listTypeListener)

sets the listener for the type changes. for example, the list view will update to show only records that correspond to the new selected subrecord type

Parameters:

listTypeListener - listens to changes in the list type. The only example of ListTypeListener appears to be ListValueManager but this may change in the future.

enableContextHelp

void enableContextHelp(boolean enableContextHelp)

controls whether context sensitive help is enabled for this UI component. if true, end-users can hover over the UI components for showing type (eg: "Show" in MultiListTypeManager) if false, context sensitive help is not active

getTypes

java.lang.String[] getTypes()

Returns:

an array of child record types defined in the XML Schema

changeFont

void changeFont(java.awt.Font font)