|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.ui.WcmAnchor
This class is a base implementation of an HTML hyperlink anchor.
Field Summary | |
protected boolean |
disabled
Indicates the anchor is disabled. |
protected java.lang.String |
extraAttributes
Any additional anchor HTML attributes. |
protected boolean |
hidden
Indicates the anchor is hidden. |
protected java.lang.String |
id
Anchor id. |
protected java.lang.String |
label
The anchor label. |
protected WcmString |
locLabel
The anchor label in WcmString format. |
protected java.lang.String |
onClick
Value of onClick attribute; |
protected java.lang.String |
onContextMenu
Value of onContextMenu attribute. |
protected boolean |
popup
Indicates a popup anchor. |
protected java.lang.String |
toolTip
The anchor tooltip. |
protected WcmURL |
urlObject
The anchor WcmURL object. |
protected java.lang.String |
urlString
The anchor url string. |
protected int |
windowHeight
Window Height |
protected int |
windowWidth
Window Width |
Constructor Summary | |
protected |
WcmAnchor()
Contructs a new WcmAnchor object. |
|
WcmAnchor(java.lang.String url,
java.lang.String label)
Contructs a new WcmAnchor object. |
|
WcmAnchor(java.lang.String url,
java.lang.String label,
java.lang.String id)
Contructs a new WcmAnchor object. |
|
WcmAnchor(java.lang.String url,
WcmString localizedLabel)
Contructs a new WcmAnchor object. |
|
WcmAnchor(java.lang.String url,
WcmString localizedLabel,
java.util.Locale locale)
Contructs a new WcmAnchor object. |
|
WcmAnchor(java.lang.String url,
WcmString localizedLabel,
java.lang.String id)
Contructs a new WcmAnchor object. |
|
WcmAnchor(WcmURL url,
java.lang.String label)
Contructs a new WcmAnchor object. |
|
WcmAnchor(WcmURL url,
WcmString localizedLabel)
Contructs a new WcmAnchor object. |
|
WcmAnchor(WcmURL url,
WcmString localizedLabel,
java.util.Locale locale)
Contructs a new WcmAnchor object. |
Method Summary | |
static WcmAnchor |
createNonLocalized(java.lang.String url,
java.lang.String label)
Deprecated. Use String based constructor instead. |
java.lang.String |
getCloseTagHTML()
Returns the anchor close tag HTML. |
java.lang.String |
getHTML()
Generates and returns the WcmAnchor HTML. |
java.lang.String |
getHTML(java.util.Locale locale)
Generates and returns the WcmAnchor HTML. |
java.lang.String |
getHTML(java.lang.String extraAttributes)
Generates and returns the WcmAnchor HTML. |
java.lang.String |
getHTML(java.lang.String extraAttributes,
java.util.Locale locale)
Generates and returns the WcmAnchor HTML. |
java.lang.String |
getId()
Returns anchor id |
java.lang.String |
getLabel()
Returns the anchor label. |
java.lang.String |
getLabel(java.util.Locale locale)
Returns the anchor label. |
java.lang.String |
getOpenTagHTML()
Returns the anchor open tag HTML. |
java.lang.String |
getOpenTagHTML(java.lang.String extraAttributes)
Creates the anchor open tag HTML with the extra HTML attributes and returns the open tag HTML. |
java.lang.String |
getToolTip()
Returns the anchor tooltip. |
java.lang.String |
getURL()
Returns the WcmAnchor url string. |
int |
getWindowHeight()
|
int |
getWindowWidth()
|
boolean |
isDisabled()
Returns true to indicate a disabled anchor. |
boolean |
isHidden()
Returns true to indicate a hidden anchor. |
boolean |
isPopup()
Returns true to indicate a pop up anchor. |
void |
setDisabled(boolean disabled)
Sets the anchor disabled property. |
void |
setHidden(boolean hidden)
Sets the anchor hidden property. |
void |
setId(java.lang.String id)
Sets anchor id |
void |
setNonLocalizedLabel(java.lang.String newLabel)
Sets label attribute of anchor |
void |
setOnClick(java.lang.String javaScript)
Sets onClick attribute of an anchor |
void |
setOnContextMenu(java.lang.String javaScript)
Sets onContextMenu attribute of an anchor |
void |
setPopup(boolean popup)
Sets the anchor pop up property. |
void |
setToolTip(java.lang.String toolTip)
Sets the anchor tooltip. |
void |
setToolTip(WcmString localizedToolTip)
Sets the anchor tooltip. |
void |
setToolTip(WcmString localizedToolTip,
java.util.Locale locale)
Sets the anchor tooltip. |
void |
setURL(java.lang.String url)
Set the URL to a new value. |
void |
setURL(WcmURL wcmUrl)
Set the URL to a new value. |
void |
setWindowHeight(int windowHeight)
|
void |
setWindowWidth(int windowWidth)
|
java.lang.String |
toString()
Returns the anchor label and url string. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected WcmURL urlObject
protected java.lang.String urlString
protected java.lang.String label
protected WcmString locLabel
protected java.lang.String toolTip
protected java.lang.String extraAttributes
protected boolean popup
protected boolean disabled
protected boolean hidden
protected java.lang.String id
protected java.lang.String onContextMenu
protected java.lang.String onClick
protected int windowHeight
protected int windowWidth
Constructor Detail |
protected WcmAnchor()
public WcmAnchor(java.lang.String url, WcmString localizedLabel)
url
- The url string of the new anchor.localizedLabel
- The localized label of the new anchor.public WcmAnchor(java.lang.String url, WcmString localizedLabel, java.util.Locale locale)
url
- The url string of the new anchor.localizedLabel
- The localized label of the new anchor.locale
- client localepublic WcmAnchor(java.lang.String url, WcmString localizedLabel, java.lang.String id)
url
- The url string of the new anchor.localizedLabel
- The localized label of the new anchor.id
- as Stringpublic WcmAnchor(WcmURL url, WcmString localizedLabel)
url
- The WcmURL object. The WcmURL object contains the anchor url string.localizedLabel
- The localized label of the new anchor.public WcmAnchor(WcmURL url, WcmString localizedLabel, java.util.Locale locale)
url
- The WcmURL object. The WcmURL object contains the anchor url string.localizedLabel
- The localized label of the new anchor.locale
- client localepublic WcmAnchor(WcmURL url, java.lang.String label)
url
- The WcmURL object. The WcmURL object contains the anchor url string.label
- The label of the new anchor.public WcmAnchor(java.lang.String url, java.lang.String label)
url
- The url string of the new anchor.label
- The label of the new anchor.public WcmAnchor(java.lang.String url, java.lang.String label, java.lang.String id)
url
- The url string of the new anchor.label
- The label of the new anchor.Method Detail |
public static WcmAnchor createNonLocalized(java.lang.String url, java.lang.String label)
url
- The url string of the new anchor.label
- The label of the new anchor.
public void setURL(java.lang.String url)
url
- public void setURL(WcmURL wcmUrl)
wcmUrl
- public java.lang.String getURL()
public java.lang.String getHTML(java.lang.String extraAttributes, java.util.Locale locale)
extraAttributes
- Any additional anchor HTML attributes. For a disabled anchor, the extra attributes will be added
to the <span> tag. Otherwise, it is added to the <a> tag.
public java.lang.String getHTML(java.lang.String extraAttributes)
extraAttributes
- Any additional anchor HTML attributes. For a disabled anchor, the extra attributes will be added
to the <span> tag. Otherwise, it is added to the <a> tag.
public java.lang.String getHTML()
public java.lang.String getHTML(java.util.Locale locale)
locale
- client locale
public java.lang.String getOpenTagHTML(java.lang.String extraAttributes)
extraAttributes
- Any additional anchor HTML attributes. For a disabled anchor, the extra attributes will be added
to the <span> tag. Otherwise, it is added to the <a> tag.
public java.lang.String getOpenTagHTML()
public java.lang.String getCloseTagHTML()
public void setOnContextMenu(java.lang.String javaScript)
javaScript
- public void setOnClick(java.lang.String javaScript)
javaScript
- public java.lang.String getLabel()
public java.lang.String getLabel(java.util.Locale locale)
locale
- client locale
public void setNonLocalizedLabel(java.lang.String newLabel)
newLabel
- public java.lang.String getToolTip()
public void setToolTip(WcmString localizedToolTip)
localizedToolTip
- The anchor localized tooltip.public void setToolTip(WcmString localizedToolTip, java.util.Locale locale)
localizedToolTip
- The anchor localized tooltip.locale
- client localepublic void setToolTip(java.lang.String toolTip)
toolTip
- The anchor localized tooltip.public boolean isPopup()
public void setPopup(boolean popup)
popup
- Set to true to create a pop up anchor.public boolean isHidden()
public void setHidden(boolean hidden)
hidden
- Set to true to hide the anchor.public boolean isDisabled()
public void setDisabled(boolean disabled)
disabled
- Set to true to disable the anchor.public java.lang.String toString()
public java.lang.String getId()
public void setId(java.lang.String id)
id
- anchor idpublic int getWindowHeight()
public void setWindowHeight(int windowHeight)
public int getWindowWidth()
public void setWindowWidth(int windowWidth)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |