Interface Targetable
-
- All Superinterfaces:
Serializable
,WComponent
,WebComponent
- All Known Implementing Classes:
WAudio
,WContent
,WEditableImage
,WImage
,WMultiFileWidget
,WTree
,WVideo
public interface Targetable extends WComponent
WComponents can be marked as targetable. This means they can be directly targeted via a url to return to the client just their fragment of content, rather than the entire application. They can also be used to return content other than html, such as images and PDFs.- Since:
- 1.0.0
- Author:
- Martin Shevchenko
-
-
Field Summary
-
Fields inherited from interface com.github.bordertech.wcomponents.WComponent
DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getTargetId()
The target id returned must be unique across all targetable WComponents within the application.-
Methods inherited from interface com.github.bordertech.wcomponents.WComponent
addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, handleRequest, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate
-
-
-
-
Method Detail
-
getTargetId
String getTargetId()
The target id returned must be unique across all targetable WComponents within the application. In a portal environment, the target ids must also be unique across portlets. Most components should just return their component id.- Returns:
- the target id for this targetable.
-
-