com.ge.research.acuity.ui
Class DisplayGroupPO

java.lang.Object
  com.ge.research.acuity.ui.PresentationObject
      com.ge.research.acuity.ui.IndependentDisplayPO
          com.ge.research.acuity.ui.DisplayGroupPO

Direct Known Subclasses:

FormInputPO

public class DisplayGroupPO

extends IndependentDisplayPO

Presentation object that represents a group of related presentation objects that should be rendered together.

Version:

$Revision: 1.1 $ $Date: 2006/08/11 00:17:24 $

Author:

garbiras

Created on:

Aug 3, 2005

Constructor Summary

DisplayGroupPO()
Calls default constructor with PresentationNatureConstants.DISPLAYGROUP.

DisplayGroupPO(java.lang.String nature)
The default constructor.

Method Summary

void	addPresentationObject(IndependentDisplayPO po) Adds a PresentationObject to the List of presentation objects to be displayed in this group.
IndependentDisplayPO	getPresentationObject(int index) Returns the PresentationObject from the list of contained presentation objects, at the specified index
java.util.List	getPresentationObjects() Returns the list of PresentationObjects to be displayed in this group
void	removePresentationObject(IndependentDisplayPO po) Removes the specified PresentationObject from the list of contained presentation objects.
void	removePresentationObject(int index) Removes the PresentationObject, at the specified index, from the list of contained presentation objects.
void	removePresentationObjects() Removes all PresentationObjects from the list of presentation objects displayed in this group
void	setHasPresentationNature(java.lang.String string) Overrides setHasPresentationNature in PresentationObject.

Methods inherited from class com.ge.research.acuity.ui.IndependentDisplayPO

canBeRemoved, displayBanner, getHeight, getIdentifierTitle, getWidth, getXPos, getYPos, getZOrder, setCanBeRemoved, setDisplayBanner, setHeight, setIdentifier, setIdentifierTitle, setPos, setPos, setPos, setPos, setWidth, setXPos, setYPos, setZOrder

Methods inherited from class com.ge.research.acuity.ui.PresentationObject

addLookupInfo, getHasPresentationNature, getIdentifier, getLookupInfo, getSubject, hasSubject, isDisplayed, isEditable, setEditability, setIsDisplayed

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayGroupPO

public DisplayGroupPO()

Calls default constructor with PresentationNatureConstants.DISPLAYGROUP. as the argument.

See Also:

DisplayGroupPO(java.lang.String)

DisplayGroupPO

public DisplayGroupPO(java.lang.String nature)

The default constructor. Calls super(). Sets the presentation nature to the argument nature Sets the editability of presentation nature to false

See Also:

PresentationObject.PresentationObject(), PresentationObject.setHasPresentationNature(java.lang.String), PresentationObject.setEditability(java.lang.String, boolean), PresentationNatureConstants.DISPLAYGROUP, PresentationParameterConstants.NATURE

Method Detail

addPresentationObject

public void addPresentationObject(IndependentDisplayPO po)

Adds a PresentationObject to the List of presentation objects to be displayed in this group.

Parameters:

po - the presentation object to add to the list of presentation objects to be displayed in the group

getPresentationObjects

public java.util.List getPresentationObjects()

Returns the list of PresentationObjects to be displayed in this group

Returns:

The list of PresentationObjects contained by this group

getPresentationObject

public IndependentDisplayPO getPresentationObject(int index)
                                           throws java.lang.IndexOutOfBoundsException

Returns the PresentationObject from the list of contained presentation objects, at the specified index

Parameters:

index - index of the PresentationObject list to extract (zero based)

Returns:

The PresentationObject, from the list of contained presentation objects, at the specified index

Throws:

java.lang.IndexOutOfBoundsException - If the index argument is negative or greater than or equal to the number of PresentationObjects contained by this group

removePresentationObjects

public void removePresentationObjects()

Removes all PresentationObjects from the list of presentation objects displayed in this group

removePresentationObject

public void removePresentationObject(IndependentDisplayPO po)

Removes the specified PresentationObject from the list of contained presentation objects.

Parameters:

po - the presentation object to remove from the list of presentation objects to display

removePresentationObject

public void removePresentationObject(int index)
                              throws java.lang.IndexOutOfBoundsException

Removes the PresentationObject, at the specified index, from the list of contained presentation objects. Sets the editability of the presentation object's position parameters to true.

Parameters:

index - index of the presentation object list to remove (zero based)

Throws:

java.lang.IndexOutOfBoundsException - If the index argument is negative or greater than or equal to the number of presentation objects contained by this group

setHasPresentationNature

public void setHasPresentationNature(java.lang.String string)

Overrides setHasPresentationNature in PresentationObject. This method does nothing since this class MUST be of presentation nature PresentationNatureConstants.DISPLAYGROUP

Overrides:

setHasPresentationNature in class PresentationObject

Parameters:

string - IGNORED. The presentation nature is not editable for a DisplayGroup

See Also:

PresentationNatureConstants.isPresentationNature(java.lang.String)