de.smartics.resteasy.hypermedia.renderer
Class LinkMetadata

java.lang.Object
  de.smartics.resteasy.hypermedia.renderer.LinkMetadata

All Implemented Interfaces:

Serializable, Cloneable

public class LinkMetadata
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable, 
      
      Cloneable
     
     

Provides link metadata that describes the link.

See Also:

a – hyperlink, Common Attributes, Serialized Form

Constructor Summary

LinkMetadata()
Default constructor.

Method Summary

Object	clone() Returns a shallow copy of the object.
String	getAccessKey() Returns the key label or list of key labels with which to associate the element; each key label represents a keyboard shortcut which UAs can use to activate the element or give focus to the element.
String	getContextMenu() Returns the identifier of a menu with which to associate the element as a context menu.
String	getCssClass() Returns the CSS class information to the link.
String	getDir() Returns the element’s text directionality.
String	getHelp() Returns the detailed help information on the link.
String	getId() Returns the identifier of the link.
String	getLabel() Returns the standard label to be rendered as the visible part of the link.
String	getMedia() Returns the media for which the destination of the hyperlink was designed.
String	getShortLabel() Returns a short version of the label to be rendered in confined space.
Integer	getTabIndex() Returns the tab index.
String	getTarget() Returns the name or keyword giving a browsing context for UAs to use when following the hyperlink.
String	getTitle() Returns the advisory information associated with the element.
Boolean	isHidden() Returns the hidden flag to specify that the element represents an element that is not yet, or is no longer, relevant.
void	setAccessKey(String accessKey) Sets the key label or list of key labels with which to associate the element; each key label represents a keyboard shortcut which UAs can use to activate the element or give focus to the element.
void	setContextMenu(String contextMenu) Sets the identifier of a menu with which to associate the element as a context menu.
void	setCssClass(String cssClass) Sets the CSS class information to the link.
void	setDir(String dir) Sets the element’s text directionality.
void	setHelp(String help) Sets the detailed help information on the link.
void	setHidden(Boolean hidden) Sets the hidden flag to specify that the element represents an element that is not yet, or is no longer, relevant.
void	setId(String id) Sets the identifier of the link.
void	setLabel(String label) Sets the standard label to be rendered as the visible part of the link.
void	setMedia(String media) Sets the media for which the destination of the hyperlink was designed.
void	setShortLabel(String shortLabel) Sets a short version of the label to be rendered in confined space.
void	setTabIndex(Integer tabIndex) Sets the tab index.
void	setTarget(String target) Sets the name or keyword giving a browsing context for UAs to use when following the hyperlink.
void	setTitle(String title) Sets the advisory information associated with the element.
String	toString() Provides the properties via reflection for displaying debug information.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkMetadata

public LinkMetadata()

Default constructor.

Method Detail

getId

public String getId()

Returns the identifier of the link.

Returns:

the identifier of the link.

setId

public void setId(String id)

Sets the identifier of the link.

Parameters:

id - the identifier of the link.

getCssClass

public String getCssClass()

Returns the CSS class information to the link.

Returns:

the CSS class information to the link.

setCssClass

public void setCssClass(String cssClass)

Sets the CSS class information to the link.

Parameters:

cssClass - the CSS class information to the link.

getAccessKey

public String getAccessKey()

Returns the key label or list of key labels with which to associate the element; each key label represents a keyboard shortcut which UAs can use to activate the element or give focus to the element.

An ordered set of unique space-separated tokens, each of which must be exactly one Unicode code point in length.

Returns:

the key label or list of key labels with which to associate the element; each key label represents a keyboard shortcut which UAs can use to activate the element or give focus to the element.

setAccessKey

public void setAccessKey(String accessKey)

Sets the key label or list of key labels with which to associate the element; each key label represents a keyboard shortcut which UAs can use to activate the element or give focus to the element.

An ordered set of unique space-separated tokens, each of which must be exactly one Unicode code point in length.

Parameters:

accessKey - the key label or list of key labels with which to associate the element; each key label represents a keyboard shortcut which UAs can use to activate the element or give focus to the element.

getTabIndex

public Integer getTabIndex()

Returns the tab index.

Specifies whether the element represents an element that is is focusable (that is, an element which is part of the sequence of focusable elements in the document), and the relative order of the element in the sequence of focusable elements in the document.

Returns:

the tab index.

setTabIndex

public void setTabIndex(Integer tabIndex)

Sets the tab index.

Specifies whether the element represents an element that is is focusable (that is, an element which is part of the sequence of focusable elements in the document), and the relative order of the element in the sequence of focusable elements in the document.

Parameters:

tabIndex - the tab index.

getTitle

public String getTitle()

Returns the advisory information associated with the element.

Returns:

the advisory information associated with the element.

setTitle

public void setTitle(String title)

Sets the advisory information associated with the element.

Parameters:

title - the advisory information associated with the element.

getDir

public String getDir()

Returns the element’s text directionality.

Returns:

the element’s text directionality.

setDir

public void setDir(String dir)

Sets the element’s text directionality.

Parameters:

dir - the element’s text directionality.

isHidden

public Boolean isHidden()

Returns the hidden flag to specify that the element represents an element that is not yet, or is no longer, relevant.

Returns:

the hidden flag to specify that the element represents an element that is not yet, or is no longer, relevant.

setHidden

public void setHidden(Boolean hidden)

Sets the hidden flag to specify that the element represents an element that is not yet, or is no longer, relevant.

Parameters:

hidden - the hidden flag to specify that the element represents an element that is not yet, or is no longer, relevant.

getLabel

public String getLabel()

Returns the standard label to be rendered as the visible part of the link.

Returns:

the standard label to be rendered as the visible part of the link.

setLabel

public void setLabel(String label)

Sets the standard label to be rendered as the visible part of the link.

Parameters:

label - the standard label to be rendered as the visible part of the link.

getShortLabel

public String getShortLabel()

Returns a short version of the label to be rendered in confined space.

Returns:

a short version of the label to be rendered in confined space.

setShortLabel

public void setShortLabel(String shortLabel)

Sets a short version of the label to be rendered in confined space.

Parameters:

shortLabel - a short version of the label to be rendered in confined space.

getHelp

public String getHelp()

Returns the detailed help information on the link.

Returns:

the detailed help information on the link.

setHelp

public void setHelp(String help)

Sets the detailed help information on the link.

Parameters:

help - the detailed help information on the link.

getTarget

public String getTarget()

Returns the name or keyword giving a browsing context for UAs to use when following the hyperlink.

Returns:

the name or keyword giving a browsing context for UAs to use when following the hyperlink.

setTarget

public void setTarget(String target)

Sets the name or keyword giving a browsing context for UAs to use when following the hyperlink.

Parameters:

target - the name or keyword giving a browsing context for UAs to use when following the hyperlink.

getMedia

public String getMedia()

Returns the media for which the destination of the hyperlink was designed.

Values are according to Media Queries.

Returns:

the media for which the destination of the hyperlink was designed.

setMedia

public void setMedia(String media)

Sets the media for which the destination of the hyperlink was designed.

Values are according to Media Queries.

Parameters:

media - the media for which the destination of the hyperlink was designed.

getContextMenu

public String getContextMenu()

Returns the identifier of a menu with which to associate the element as a context menu.

Returns:

the identifier of a menu with which to associate the element as a context menu.

setContextMenu

public void setContextMenu(String contextMenu)

Sets the identifier of a menu with which to associate the element as a context menu.

Parameters:

contextMenu - the identifier of a menu with which to associate the element as a context menu.

clone

public Object clone()

Returns a shallow copy of the object.

Overrides:

clone in class Object

Returns:

a shallow copy.

toString

public String toString()

Provides the properties via reflection for displaying debug information.

Overrides:

toString in class Object

See Also:

Object.toString()