com.ge.research.acuity.ui
Class DocumentPO

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

public class DocumentPO

extends IndependentDisplayPO

A presentation object that represents a reference to information or document content that exists outside of the ontology. The referenced content is either read in and displayed within an acuity presentation object frame window, or is referenced as a link to follow in order to get the information content.

Version:

$Revision: 1.2 $ $Date: 2007/03/08 16:14:14 $

Author:

garbiras

Created on:

Jan 21, 2005

Constructor Summary

DocumentPO()
Calls the default constructor with null argument

DocumentPO(java.lang.String text)
The default constructor.

Method Summary

java.lang.String	getHasCurrentURL() Returns the document current URL which is the content of this PresentationObject
java.lang.String	getHasURL() Returns the initial document URL which is the content of this PresentationObject
java.lang.String	getLinkDisplayText() Returns the display text to use if this presentation object is of nature PresentationNatureConstants.LINK
java.lang.String	getTarget() Returns the target (window) to use if this presentation object is of nature PresentationNatureConstants.LINK
java.lang.String	getURL() Returns the document URL which is the content of this PresentationObject
boolean	isExternal() Returns the flag indicating whether or not this presentation object, if it is of nature link, should open that link in a frame/media different from that in which it is displayed.
void	setHasCurrentURL(java.lang.String string) Sets the document current URL to be the content of this PresentationObject
void	setHasPresentationNature(java.lang.String string) Overrides setHasPresentationNature in PresentationObject.
void	setHasURL(java.lang.String string) Sets the intial document URL to be the content of this PresentationObject
void	setIsExternal(boolean b) Sets the flag indicating whether or not this presentation object, if it is of nature link, should open that link in a frame/media different from that in which it is displayed.
void	setLinkDisplayText(java.lang.String string) Sets the display text to use if this presentation object is of nature PresentationNatureConstants.LINK
void	setTarget(java.lang.String string) Sets the target window to use if this presentation object is of nature PresentationNatureConstants.LINK

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

DocumentPO

public DocumentPO()

Calls the default constructor with null argument

DocumentPO

public DocumentPO(java.lang.String text)

The default constructor. Calls super(). Sets the presentation nature to PresentationNatureConstants.CONTENT Sets the editability for document url to false

Parameters:

text - the document current URL

See Also:

PresentationObject.PresentationObject(), setHasURL(java.lang.String), PresentationObject.setHasPresentationNature(java.lang.String), PresentationObject.setEditability(java.lang.String, boolean), PresentationNatureConstants.CONTENT, PresentationParameterConstants.DOCUMENT_CURRENT_URL

Method Detail

getHasCurrentURL

public java.lang.String getHasCurrentURL()

Returns the document current URL which is the content of this PresentationObject

Returns:

The document current URL of the content of the presentation object

getHasURL

public java.lang.String getHasURL()

Returns the initial document URL which is the content of this PresentationObject

Returns:

The initial document URL of the content of the presentation object

getLinkDisplayText

public java.lang.String getLinkDisplayText()

Returns the display text to use if this presentation object is of nature PresentationNatureConstants.LINK

Returns:

The text to display as a link, if this presentation object is of nature link

getTarget

public java.lang.String getTarget()

Returns the target (window) to use if this presentation object is of nature PresentationNatureConstants.LINK

Returns:

The target (window), if this presentation object is of nature link

getURL

public java.lang.String getURL()

Returns the document URL which is the content of this PresentationObject

Returns:

The document URL of the content of the presentation object

isExternal

public boolean isExternal()

Returns the flag indicating whether or not this presentation object, if it is of nature link, should open that link in a frame/media different from that in which it is displayed.

Returns:

true if the link should be opened in a seperate frame/media; false if the link should be opened in the same frame/media as the presentation object

setHasPresentationNature

public void setHasPresentationNature(java.lang.String string)

Overrides setHasPresentationNature in PresentationObject. Checks that the new value for presentation nature is a valid type for a DocumentPO. If not, the value of presentation nature does not change.

Overrides:

setHasPresentationNature in class PresentationObject

Parameters:

string - the new value of presentation nature

See Also:

PresentationNatureConstants.isReferenceType(java.lang.String)

setHasCurrentURL

public void setHasCurrentURL(java.lang.String string)

Sets the document current URL to be the content of this PresentationObject

Parameters:

string - the document current URL of the content of this presentation object

setHasURL

public void setHasURL(java.lang.String string)

Sets the intial document URL to be the content of this PresentationObject

Parameters:

string - the initial document URL of the content of this presentation object

setIsExternal

public void setIsExternal(boolean b)

Sets the flag indicating whether or not this presentation object, if it is of nature link, should open that link in a frame/media different from that in which it is displayed.

Parameters:

b - true if the link should be opened in a seperate frame/media; false if the link should be opened in the same frame/media as the presentation object

setLinkDisplayText

public void setLinkDisplayText(java.lang.String string)

Sets the display text to use if this presentation object is of nature PresentationNatureConstants.LINK

Parameters:

string - the text to display as a link, if this presentation object is of nature link

setTarget

public void setTarget(java.lang.String string)

Sets the target window to use if this presentation object is of nature PresentationNatureConstants.LINK

Parameters:

string - the target window, if this presentation object is of nature link