com.ibm.xsp.resource
Class LinkResource

java.lang.Object
  extended by com.ibm.xsp.complex.ValueBindingObjectImpl
      extended by com.ibm.xsp.resource.AbstractResource
          extended by com.ibm.xsp.resource.LinkResource
All Implemented Interfaces:
ComponentBindingObject, EncodableObject, ValueBindingObject, FacesAttrsObject, Resource, javax.faces.component.StateHolder

public class LinkResource
extends AbstractResource
implements EncodableObject, FacesAttrsObject

Corresponds to the xp:linkResource tag which is used to load generic HTML link resources


Field Summary
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class com.ibm.xsp.resource.AbstractResource
FAMILY
 
Constructor Summary
LinkResource()
          Default Constructor
 
Method Summary
 void addAttr(Attr attr)
          Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
 java.util.List<Attr> getAttrs()
          The extra attributes to be output on the base element at the root of this control or object tag.
 java.lang.String getCharset()
          Indicates the character encoding of the linked resource.
 java.lang.String getDir()
          Specifies the direction for text that does not inherit a direction.
 java.lang.String getHref()
          Indicates the href of the linked resource.
 java.lang.String getHreflang()
          Indicates the hreflang of the linked resource.
 java.lang.String getId()
          Specifies the id of the link
 java.lang.String getMedia()
          Returns the media that the link is connected to
 java.lang.String getRel()
          Specifies the relationship between the current document and the anchor referenced by the control.
 java.lang.String getRev()
          Specifies a reverse link from the anchor referenced by the control to the current document.
 java.lang.String getStyle()
          Specifies CSS style(s) to be applied when this control is rendered.
 java.lang.String getStyleClass()
          Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered.
 java.lang.String getTarget()
          Specifies the location where a linked document is loaded.
 java.lang.String getTitle()
          Provides title information for controls.
 java.lang.String getType()
          Specifies the MIME type of the linked document.
protected  java.lang.String getUrl()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAttrs(java.util.List<Attr> attrs)
          This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
 void setCharset(java.lang.String charset)
          The value to set.
 void setDir(java.lang.String dir)
          The dir to set.
 void setHref(java.lang.String href)
          The href to set
 void setHreflang(java.lang.String hreflang)
          The hreflang to set
 void setId(java.lang.String id)
          The id to set.
 void setMedia(java.lang.String media)
          The media to set.
 void setRel(java.lang.String rel)
          The rel to set
 void setRev(java.lang.String rev)
          The rev to set.
 void setStyle(java.lang.String style)
          The style to set.
 void setStyleClass(java.lang.String styleClass)
          The styleClass to set
 void setTarget(java.lang.String target)
          The target to set.
 void setTitle(java.lang.String title)
          The The title to set.
 void setType(java.lang.String type)
          The type to set
 java.lang.String toString()
           
 
Methods inherited from class com.ibm.xsp.resource.AbstractResource
encodeObject, equals, getFamily, getRendererType, getServerResourceContents, getUniqueId, isRendered, loadContents, setRendered, setRendererType
 
Methods inherited from class com.ibm.xsp.complex.ValueBindingObjectImpl
getComponent, getFacesContext, getValueBinding, isTransient, setComponent, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.xsp.complex.EncodableObject
encodeObject
 

Field Detail

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

LinkResource

public LinkResource()
Default Constructor

Method Detail

getCharset

public java.lang.String getCharset()
Indicates the character encoding of the linked resource. Same as the HTML "link" tag's "charset" attribute.

Returns:
Returns the charset.

setCharset

public void setCharset(java.lang.String charset)
The value to set.

Parameters:
charset -

getHref

public java.lang.String getHref()
Indicates the href of the linked resource. Same as the HTML "link" tag's "href" attribute.

Returns:
href

setHref

public void setHref(java.lang.String href)
The href to set

Parameters:
href -

getHreflang

public java.lang.String getHreflang()
Indicates the hreflang of the linked resource. Same as the HTML "link" tag's "href" attribute.

Returns:
hreflang

setHreflang

public void setHreflang(java.lang.String hreflang)
The hreflang to set

Parameters:
hreflang -

getMedia

public java.lang.String getMedia()
Returns the media that the link is connected to

Returns:
Returns the media

setMedia

public void setMedia(java.lang.String media)
The media to set.

Parameters:
media -
media -

getRel

public java.lang.String getRel()
Specifies the relationship between the current document and the anchor referenced by the control. The value is a list of link types separated by spaces.

Returns:
Returns the rel

setRel

public void setRel(java.lang.String rel)
The rel to set

Parameters:
rel -

getRev

public java.lang.String getRev()
Specifies a reverse link from the anchor referenced by the control to the current document. Value is list of link types separated by spaces

Returns:
Returns the rev

setRev

public void setRev(java.lang.String rev)
The rev to set.

Parameters:
rev -

getTarget

public java.lang.String getTarget()
Specifies the location where a linked document is loaded.

Returns:
Returns the target

setTarget

public void setTarget(java.lang.String target)
The target to set.

Parameters:
target -

getType

public java.lang.String getType()
Specifies the MIME type of the linked document.

Returns:
Returns the type.

setType

public void setType(java.lang.String type)
The type to set

Parameters:
The - type to set.

getStyleClass

public java.lang.String getStyleClass()
Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup

Returns:
Returns the styleClass

setStyleClass

public void setStyleClass(java.lang.String styleClass)
The styleClass to set

Parameters:
styleClass. -

getDir

public java.lang.String getDir()
Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left)

Returns:
Returns the dir.

setDir

public void setDir(java.lang.String dir)
The dir to set.

Parameters:
dir -

getId

public java.lang.String getId()
Specifies the id of the link

Returns:
Returns the id

setId

public void setId(java.lang.String id)
The id to set.

Parameters:
id -

getStyle

public java.lang.String getStyle()
Specifies CSS style(s) to be applied when this control is rendered.

Returns:
Returns the style.

setStyle

public void setStyle(java.lang.String style)
The style to set.

Parameters:
style -

getTitle

public java.lang.String getTitle()
Provides title information for controls.

Returns:
Returns the title.

setTitle

public void setTitle(java.lang.String title)
The The title to set. to set.

Parameters:
title -

getAttrs

public java.util.List<Attr> getAttrs()
The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:
getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)
Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:
addAttr in interface FacesAttrsObject
Parameters:
action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)
This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.


getUrl

protected java.lang.String getUrl()

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class AbstractResource

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class AbstractResource

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object