@AccessLevel(value=EXTERNAL)
public class ParticipantMessageLink
extends java.lang.Object
ParticipantMessage
.Modifier and Type | Field and Description |
---|---|
protected boolean |
hideMenuBar
Stores whether or not the menu bar of the new browser window should be
displayed.
|
protected boolean |
hideToolBar
Stores whether or not the tool bar of the new browser window should be
displayed.
|
protected boolean |
isExternalLink
The is external link.
|
protected boolean |
modalInd
Indicates whether this link is to be opened in a modal window.
|
protected java.lang.String |
name
The name of a link.
|
protected java.lang.Integer |
newWindowHeight
The height of the new browser window to be opened.
|
protected java.lang.Integer |
newWindowWidth
The width of the new browser window to be opened.
|
protected boolean |
openInNewWindow
Indicates whether this link is to be opened in a new browser window.
|
protected java.util.HashMap<java.lang.String,java.lang.String> |
parameters
HashMap to store the arguments to be passed with this link.
|
protected java.lang.String |
target
The URL or 'href' value of this link.
|
Constructor and Description |
---|
ParticipantMessageLink(boolean modalInd,
java.lang.String aTarget,
java.lang.String aName)
Constructor used to create a ParticipantMessageLink and populate its
values.
|
ParticipantMessageLink(boolean modalInd,
java.lang.String aTarget,
java.lang.String aName,
boolean isExternalLink)
Constructor used to create a ParticipantMessageLink and populate its
values.
|
Modifier and Type | Method and Description |
---|---|
void |
addParameter(java.lang.String name,
java.lang.String value)
Add a parameter to the list of parameters for this link.
|
protected java.lang.Integer |
getNewWindowHeight()
Returns the height of the new browser window to be opened.
|
protected java.lang.Integer |
getNewWindowWidth()
Returns the width of the new browser window to be opened.
|
java.util.HashMap<java.lang.String,java.lang.String> |
getParameters()
Returns true if the map of arguments for this message is populated.
|
java.lang.String |
getTarget()
Returns the URL for this link.
|
void |
hideBrowserMenuBar()
Using in conjunction with
openInNewWindow() . |
void |
hideBrowserToolBar()
Using in conjunction with
openInNewWindow() . |
java.lang.Boolean |
isExternalLink()
Indicates whether this link is an external link.
|
java.lang.Boolean |
isModal()
Indicates whether this link should be displayed in a modal window.
|
java.lang.Boolean |
openInNewWindow()
Indicates whether or not this link is to be opened in a new browser window.
|
void |
openInNewWindow(java.lang.Integer height,
java.lang.Integer width)
Indicates that this Link is to be opened in a new browser window, and
specifies the width and height of the new browser window, in pixels.
|
protected java.lang.Boolean |
shouldHideMenuBar()
Returns whether or not the browser menu bar should be hidden when launching
this link in a new browser menu.
|
protected java.lang.Boolean |
shouldHideToolBar()
Returns whether or not the browser tool bar should be hidden when launching
this link in a new browser menu.
|
protected java.lang.String target
protected java.lang.String name
protected boolean modalInd
protected boolean openInNewWindow
protected java.lang.Integer newWindowHeight
protected java.lang.Integer newWindowWidth
protected boolean isExternalLink
protected java.util.HashMap<java.lang.String,java.lang.String> parameters
protected boolean hideMenuBar
protected boolean hideToolBar
public ParticipantMessageLink(boolean modalInd, java.lang.String aTarget, java.lang.String aName)
modalInd
- whether this link is to be opened in a modal window.aTarget
- The URL or 'href' value of this link.aName
- The name of a link. Used to identify where it should be
substituted in the property value associated with the parent
ParticipantMessage. For example, in the property file, you may
have something like {link:My Activities:My.Activities}. In this
case 'My.Activities' should be specified as the name of the link.public ParticipantMessageLink(boolean modalInd, java.lang.String aTarget, java.lang.String aName, boolean isExternalLink)
modalInd
- whether this link is to be opened in a modal window.aTarget
- The URL or 'href' value of this link.aName
- The name of a link. Used to identify where it should be
substituted in the property value associated with the parent
ParticipantMessage. For example, in the property file, you may
have something like {link:My Activities:My.Activities}. In this
case 'My.Activities' should be specified as the name of the link.isExternalLink
- The is external link indicator.public void addParameter(java.lang.String name, java.lang.String value)
name
- The name or key of this parameter.value
- The value of this parameter.public java.lang.Boolean isModal()
public java.util.HashMap<java.lang.String,java.lang.String> getParameters()
public java.lang.String getTarget()
public void openInNewWindow(java.lang.Integer height, java.lang.Integer width)
isModal()
. A
link is either modal or to be opened in a new browser window, but not both.
If both are specified, the link will open in a modal window, with the width
and height specified on this method being disregarded.height
- the height, in pixels, of the new browser window.width
- the width, in pixels, of the new browser window.public void hideBrowserMenuBar()
openInNewWindow()
. Specifies that the
browser menu bar should be hidden when launching this link in a new browser
window.public void hideBrowserToolBar()
openInNewWindow()
. Specifies that the
browser tool bar should be hidden when launching this link in a new browser
window.public java.lang.Boolean openInNewWindow()
protected java.lang.Integer getNewWindowHeight()
protected java.lang.Integer getNewWindowWidth()
protected java.lang.Boolean shouldHideMenuBar()
protected java.lang.Boolean shouldHideToolBar()
public java.lang.Boolean isExternalLink()