Google Git
Sign in
eclipse / gerrit / www.eclipse.org / nebula / edddf1c46f5aee0e7de034aaa627130ae4d84c93 / . / releases / 2.4.3 / javadoc / org / eclipse / nebula / widgets / xviewer / customize / IXViewerCustomizations.html
blob: b3de50bd99213912546aae857f65972783b80999 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Jul 23 15:58:38 CEST 2020 -->
<title>IXViewerCustomizations</title>
<meta name="date" content="2020-07-23">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IXViewerCustomizations";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IXViewerCustomizations.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/FilterDataUI.html" title="class in org.eclipse.nebula.widgets.xviewer.customize"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/SearchDataUI.html" title="class in org.eclipse.nebula.widgets.xviewer.customize"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html" target="_top">Frames</a></li>
<li><a href="IXViewerCustomizations.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.nebula.widgets.xviewer.customize</div>
<h2 title="Interface IXViewerCustomizations" class="title">Interface IXViewerCustomizations</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/FileStoreCustomizations.html" title="class in org.eclipse.nebula.widgets.xviewer.customize">FileStoreCustomizations</a>, <a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/XViewerCustomizations.html" title="class in org.eclipse.nebula.widgets.xviewer.customize">XViewerCustomizations</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IXViewerCustomizations</span></pre>
<div class="block">Methods to implement if this XViewer allows the user to save local/shared customizations</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html#deleteCustomization-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-">deleteCustomization</a></span>(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;custData)</code>
<div class="block">Delete customization</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html#getSavedCustDatas--">getSavedCustDatas</a></span>()</code>
<div class="block">Load and return saved customizations</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html#getUserDefaultCustData--">getUserDefaultCustData</a></span>()</code>
<div class="block">Return customization saved as default</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html#isCustomizationPersistAvailable--">isCustomizationPersistAvailable</a></span>()</code>
<div class="block">Return true if this XViewer is allowed to save local/shared customizations</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html#isCustomizationUserDefault-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-">isCustomizationUserDefault</a></span>(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;custData)</code>
<div class="block">Return true if given customization is the default</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html#saveCustomization-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-">saveCustomization</a></span>(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;custData)</code>
<div class="block">Called to have customization saved</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html#setUserDefaultCustData-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-boolean-">setUserDefaultCustData</a></span>(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;newCustData,
boolean&nbsp;set)</code>
<div class="block">Set given customization as the user default</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="saveCustomization-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveCustomization</h4>
<pre>void&nbsp;saveCustomization(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;custData)
throws java.lang.Exception</pre>
<div class="block">Called to have customization saved</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="getSavedCustDatas--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSavedCustDatas</h4>
<pre>java.util.List&lt;org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&gt;&nbsp;getSavedCustDatas()
throws java.lang.Exception</pre>
<div class="block">Load and return saved customizations</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="getUserDefaultCustData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserDefaultCustData</h4>
<pre>org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;getUserDefaultCustData()
throws <a href="../../../../../../org/eclipse/nebula/widgets/xviewer/util/XViewerException.html" title="class in org.eclipse.nebula.widgets.xviewer.util">XViewerException</a></pre>
<div class="block">Return customization saved as default</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/util/XViewerException.html" title="class in org.eclipse.nebula.widgets.xviewer.util">XViewerException</a></code></dd>
</dl>
</li>
</ul>
<a name="isCustomizationUserDefault-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCustomizationUserDefault</h4>
<pre>boolean&nbsp;isCustomizationUserDefault(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;custData)
throws <a href="../../../../../../org/eclipse/nebula/widgets/xviewer/util/XViewerException.html" title="class in org.eclipse.nebula.widgets.xviewer.util">XViewerException</a></pre>
<div class="block">Return true if given customization is the default</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if default</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/util/XViewerException.html" title="class in org.eclipse.nebula.widgets.xviewer.util">XViewerException</a></code></dd>
</dl>
</li>
</ul>
<a name="setUserDefaultCustData-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserDefaultCustData</h4>
<pre>void&nbsp;setUserDefaultCustData(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;newCustData,
boolean&nbsp;set)
throws java.lang.Exception</pre>
<div class="block">Set given customization as the user default</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="deleteCustomization-org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteCustomization</h4>
<pre>void&nbsp;deleteCustomization(org.eclipse.nebula.widgets.xviewer.core.model.CustomizeData&nbsp;custData)
throws java.lang.Exception</pre>
<div class="block">Delete customization</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="isCustomizationPersistAvailable--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isCustomizationPersistAvailable</h4>
<pre>boolean&nbsp;isCustomizationPersistAvailable()</pre>
<div class="block">Return true if this XViewer is allowed to save local/shared customizations</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IXViewerCustomizations.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/FilterDataUI.html" title="class in org.eclipse.nebula.widgets.xviewer.customize"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/eclipse/nebula/widgets/xviewer/customize/SearchDataUI.html" title="class in org.eclipse.nebula.widgets.xviewer.customize"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/nebula/widgets/xviewer/customize/IXViewerCustomizations.html" target="_top">Frames</a></li>
<li><a href="IXViewerCustomizations.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>