function obj=jcontrol(Parent, Style, varargin)

% JCONTROL constructor for JCONTROL class

%
% JCONTROL provides an easy way to integrate a full range of java GUIs
% from the java.awt and javax.swing libraries into MATLAB.
%
% -------------------------------------------------------------------------
% This is a "legacy" version of jcontrol that will work back to about
% MATLAB v7.0 (See the MATLAB Central file comments for tweaks to run it
% with V7.0 and 7.01).
% A new version will be included in "Project Waterloo", a more ambitious
% MATLAB/Swing tools library that will be posted to MATLAB Central and at
% http://sourceforge.net/projects/waterloo/ in mid-2011. Waterloo will
% require MATLAB R2008a or later
% -------------------------------------------------------------------------
%
% Example:
% obj=JCONTROL(Parent, Style);
% obj=JCONTROL(Parent, Style, PropertyName1, PropertyValue1,...
% PropertyName2, PropertyValue2....);
% Inputs:
% Parent: the handle of a Matlab figure or other container for the resulting
% component (see below)
% Style: string describing a java component e.g. 'javax.swing.JPanel',
% 'javax.swing.JButton' or a variable containing a java object
% OR
% a function handle that will be called with no inputs to return a
% javaobject
% OR
% a cell array in which element 1 is a handle to a function
% returning a java object, as above, but elements 2:end will be used
% as inputs to the function.
%
% PropertName/PropertyValue pairs: these are automatically assigned to the
% HG container or the java component as appropriate.
%
% Pre-create the java object if you need to pass arguments to the
% constructor e.g.
% javaobj=javax.swing(...............);
% obj=jcontrol(Parent, javaobj);
%
%
% Valid parents for a jcontrol are:
% The ML Root: A figure will be created
% Figure: A uipanel will be created
% uipanel or other The uipanel will be used as parent. Note
% uicontainer that the Units and Position of the
% jcontrol will not be linked to the
% uipanel. This allows uipanels created
% explicitly by the user to be nested.
%
% *Do not use jcontrols or their hgjavacomponents as parents
%
%
% By default, JCONTROLs are returned with Units set to 'normalized'.
%
% USE:
% Build a GUI with repeated calls to JCONTROL in much the same way as with
% MATLAB's uicontrol function e.g.:
% h=jcontrol(gcf,'javax.swing.JPanel',...
% 'Units','pixels',...
% 'Position',[100 100 200 200]);
% h(2)=jcontrol(h(1),'javax.swing.JComboBox',...
% 'Position',[0.1 0.8 0.8 0.1]);
% h(2).addItem('Item1');
% h(2).addItem('Item2');
% h(3)=jcontrol(h(1),'javax.swing.JCheckBox',...
% 'Position',[0.1 0.1 0.1 0.1],...
% 'Label','My check box');
% See the jcontrolDemo() for a fuller example.
%
% A JCONTROL aggregates the MATLAB handle graphics container and the Java
% component (as returned by MATLAB's JAVACOMPONENT function) into a single
% object.
% Access to the JCONTROL's properties is provided by GET/SET calls.
% These automatically determine whether the target property is in
% the HG container or java object.
% myobject=jcontrol(gcf,'javax.swing.JPanel',...
% 'Units', 'normalized',...
% 'Name', 'MyPanel');
% set(myobject, 'Position', [0.4 0.4 0.4 0.2],...
% 'Enabled', 0);
% pos=get(myobject,'Units');
% Note that you can mix HG container properties (e.g. Units, Position) and
% java component properties (e.g. Name, Enabled) in single calls to
% JCONTROL and SET.
% Use the HG container to control the Units, Position, and Visible
% properties
%
% MATLAB dot notation may also be used. This notation also provides access
% to the java object's methods
% pos=myobject.Position;
% sz=myObject.getSize;
% myobject.setEnabled(1);
% myobject.setToolTipText('My tip');
% myobject.setOpaque(1);
%
% Transparency
% By default, support for transparency awt Colors is switched on. To toggle
% support on and off call jcontrol with a string input:
% jcontrol('UseTransparency');
% jcontrol(NoTransparency');
%
%--------------------------------------------------------------------------
% UNITS, POSITION and VISIBLE properties
% Set these by accessing the JCONTROL or its container (not the hgcontrol).
% MATLAB links these properties between the container and the java control,
% but unidirectionally.
% Note that JCONTROL methods always act on/return the Visible property of
% the container ('on' or 'off') which will also update the java control.
% Do not use the setVisible() methods.
%--------------------------------------------------------------------------
%
% Overloaded class methods are case-insensitive for properties but
% case-sensitive for java methods
%
% CALLBACKS
% Setting up callbacks
% The simplest way to set up a callback is through the SET method
% myPanel=jcontrol(gcf,'javax.swing.JPanel',...
% 'Units','normalized',...
% 'Position',[0.3 0.3 0.5 0.5]);
% set(myPanel, 'MouseClickedCallback', 'MyCallback')
% or
% set(myPanel, 'MouseClickedCallback', @MyCallback);
% or
% set(myPanel ,'MouseClickedCallback', {@MyCallback A B C...});
%
% The callback then takes the usual MATLAB form, e.g.
% function MyCallback(hObject, EventData)
% function MyCallback(hObject, EventData, varargin)
%
% Accessing JCONTROL objects in callbacks:
% The handle received by a callback will be that of the java control
% object contained in the JCONTROL, not the JCONTROL itself. In addition,
% GCO will return empty and GCBO will not return the parent figure handle.
% However, the JCONTROL constructor adds the HG container handle to the
% java component's properties. This can be used to access the container and
% its parent figure from within the callback e.g.
% get(hObject.hghandle);% gets the HG container
% ancestor(hObject.hghandle,'figure')% gets the parent figure handle
% To cross-reference from the container, JCONTROL places a reference to
% the java control in the container's UserData area e.g.
% hgc=findobj('Tag','MyCustomTag')
% javacontrol=get(hgc, 'UserData');
%
% Accessing data in callbacks
% Data can be passed to a callback, as above, with optional input
% arguments. In addition, data that is specific to the control can be stored
% in the application data area of the control e.g. to return values
% dependent on the selection of a popup menu
% data=getappdata(hObject,'data');
% returnvalues=data(hObject.getSelectedItem+1);
% Note: +1 because the item numbering is zero based for the java object.
% The HG container has a separate application data area.
%
% R2006a or higher only:
% GETAPPDATA, SETAPPDATA ISAPPDATA and RMAPPDATA methods have been
% overloaded for JCONTROL objects. These place/return data from the
% application data area of the java control. Take care if removing the whole
% application data area - TMW may place data in there too. The HG container
% has a separate application data area.
%
% Notes:
% If a property name occurs in both the HG container and the java object,
% the JCONTROL methods can not unambiguously identify the source/target
% and it must be defined explicitly by the user e.g.
% get(myobject.hgcontainer,'Opaque');
% set(myobject.hgcontrol, 'Opaque',0);
% The JCONTROL methods test for ambiguity and issue an error message when
% it arises. Note that the test uses MATLAB's isprop and is case
% insensitive.
% It may also detect properties not listed by the MATLAB builtin GET
% function for the hgcontrol such as Visible. The JCONTROL methods always
% act on the Visible property of the hgcontainer, letting MATLAB update the
% object automatically (see above).
%
% The DeleteFcn property of the hgcontainer is set by the JAVACOMPONENT
% function. If this property is changed, the new callback must explicitly
% delete the hgcontrol.
%
% See also:
% jcontrol/get, jcontrol/set, jcontrol/subsasgn, jcontrol/subsref
% jcontrol/setappdata, jcontrol/getappdata, jcontrol/isappdata
% jcontrol/rmappdata, jcontrol/delete
% javacomponent, gco, gcbo
%
%
% Backwards compatibility note
% The uipanel added to a jcontrol will be removed in a future version. The
% presence of the uipanel arose from changes to to the MATLAB javacomponent
% function and a desire to keep jcontrol behaviour backwards compatible
% in earlier versions. They are unnecessary for most jcontrols and untidy.
% Although still supported below, avoid using jcontrols or their
% hgjavacomponents as parents of other jcontrols for forwards compatibility.
%
%--------------------------------------------------------------------------
% Acknowledgements: The JCONTROL class was partly inspired by Yair Altman's
% <a href="http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?
objectId=14583&objectType=file">uicomponent</a> function.
% The functions take different routes to achieve similar ends. JCONTROL is rather
% faster - which is significant when building complex GUIs, but UICOMPONENT
% accepts the same calling conventions as MATLAB's UICONTROL while JCONTROL
% does not.
%--------------------------------------------------------------------------
%
% -------------------------------------------------------------------------
% Author: Malcolm Lidierth 07/07
% Copyright � The Author & King's College London 2007-
% -------------------------------------------------------------------------
%
% Revisions:
% 12.09.07 Allow pre-constructed java objects on input
% 18.10.08 Modified for R2008b compatability. Userdata property in
% container now contains handle
% 01.03.10 Add User property
% Put hghandle in UserData area of uipanel
% 03-27.05.10 Set background color of hgcontrol to match parent container
% and add support for transparency
% 17.07.10 Add support for function handles and cell arrays to specify
% the java object
% 02.02.11 Remove BackgroundColor 'none' settings - needed for
% compatibility with future MATLAB releases.
% Add warning about using jcontrols or hgjavacomponents as
% parents
% 04.04.11 Remove unused User property

persistent TransparencyFlag;

if nargin==0
% Default constructor
obj.hgcontrol=[];
obj.hghandle=[];
obj.hgcontainer=[];
obj.uipanel=[];
obj=class(orderfields(obj),'jcontrol');
 return
elseif nargin==1
switch lower(Parent)
case 'usetransparency'
TransparencyFlag=true;
case 'notransparency'
TransparencyFlag=false;
end
return
end

if isempty(TransparencyFlag)
TransparencyFlag=true;
end

obj.uipanel=[];

% Check parent
if ishandle(Parent) && Parent==0
% Root as parent - create a figure and panel
fh=figure('MenuBar','none');
%obj.uipanel=createuipanel(fh, varargin{:});
container=fh;
elseif strcmp(class(Parent),'jcontrol')
% Jcontrol - use its existing uipanel
% Note this will be removed in a future version - do not parent
% jcontrols by other jcontrols
warning('JCONTROL:obsolete', 'Using a jcontrol as a parent of a jcontrol will
become obsolete in a future version');
if isempty(Parent.uipanel) || isstruct(Parent.uipanel)
container=ancestor(Parent.hgcontainer, 'uipanel');
else
container=Parent.uipanel;
end
elseif strcmp(class(Parent),'hgjavacomponent')
% Jcontrol hgcontainer - get the uipanel from the hgcontrol
% Note this will be removed in a future version - do not parent
% jcontrols by other jcontrols
warning('JCONTROL:obsolete', 'Using an hgjavacomponent as a parent of a
jcontrol will become obsolete in a future version');
container=get(get(Parent, 'UserData'),'uipanel');
% Modified 05.11.08
elseif ishandle(Parent) && strcmpi(get(Parent, 'Type'),'uipanel')
% Uipanel provided explicitly so use it
container=Parent;
set(Parent, 'BorderType', 'none');
elseif ishandle(Parent) && strcmpi(get(Parent,'Type'), 'uitab')
container=Parent;
elseif ishandle(Parent) && strcmpi(get(Parent,'Type'), 'figure')
% Create an empty uipanel for subsequent calls to jcontrol with this
% jcontrol as parent
obj.uipanel=createuipanel(Parent, varargin{:});
container=Parent;
else
% Use anything the user specifies.
obj.uipanel=[];
container=Parent;
end
if isempty(container) || ishandle(container)==0
error('Invalid target for jcontrol');
end

% Java object
if ischar(Style)
% Create a default object
javaobject=javaObject(Style);
elseif isjava(Style)
% or use supplied object
javaobject=Style;
elseif iscell(Style)
javaobject=Style{1}(Style{2:end});
elseif isa(Style, 'function_handle')
javaobject=Style();
end

% Check we have a valid Style

if isa(javaobject,'java.awt.Window')
error('%s is a top-level container: \n%s\n',...
Style, 'it can not have a MATLAB figure as parent/ancestor');
end

% If so, add callbacks and place in container

[obj.hgcontrol containerHandle]=javacomponent(javaobject,[],container);

% Put a copy of the container handle in obj....

obj.hghandle=containerHandle;
% ... and in the control
s=schema.prop(obj.hgcontrol ,'hghandle','mxArray');
obj.hgcontrol.hghandle=containerHandle;
s.AccessFlags.PublicSet='off';

% Also include the uipanel handle

s=schema.prop(obj.hgcontrol ,'uipanel','mxArray');
obj.hgcontrol.uipanel=obj.uipanel;
s.AccessFlags.PublicSet='off';

% Put the container in obj

obj.hgcontainer = handle(containerHandle);

% 01.03.10 Put a crossreference to the hghandle in the uipanel UserData area

if ~isempty(obj.uipanel)
set(obj.uipanel, 'UserData', obj.hghandle,...
'BorderType', 'none', 'Units','normalized');
else
obj.uipanel.Position=[];%Dummy field
obj.uipanel.Units=[];%Dummy field
obj.uipanel.UserData=get(obj.hghandle, 'Parent');
end

% Construct the instance

obj=class(orderfields(obj),'jcontrol');

% Put a reference to the hgcontrol in the UserData area of the handle

set(containerHandle, 'UserData', obj.hgcontrol);

% Default to normalized
set(obj, 'Units','normalized');

% 27.05.10 Match backgrounds by default

try
try
color=get(get(obj.hgcontainer, 'Parent'),'BackgroundColor');
catch %#ok<CTCH>
try
color=get(get(obj.hgcontainer, 'Parent'),'Color');
catch %#ok<CTCH>
color=[1 1 1];
end
end
if ischar(color)
%obj.hgcontrol.getBackground();
elseif numel(color)==4 && TransparencyFlag==true
color=int16(color);
obj.hgcontrol.setBackground(java.awt.Color(color(1), color(2), color(3),
color(4)));
else
color=int16(color*255);
obj.hgcontrol.setBackground(java.awt.Color(color(1), color(2), color(3)));
end
catch
end

% Set values as requested

if ~isempty(varargin)
set(obj,varargin{:});
end

return
end

function p=createuipanel(Parent, varargin)

% Set up uipanel using default values for javacomponent container if not
% specified otherwise
TF=strcmpi('Units', varargin);
idx1=find(TF>0);
if isempty(idx1)
Units='pixels';
else
Units=varargin{idx1(end)+1};
end
TF=strcmpi('Position', varargin);
idx2=find(TF>0);
if isempty(idx2)
Position=[20 20 60 20];
else
Position=varargin{idx2(end)+1};
end
if idx1>idx2
% Needed to ensure synchrony between uipanel and hgcontainer
error('''Units'' must be specified before ''Position'' on input');
end
try
color=get(Parent,'BackgroundColor');
catch %#ok<CTCH>
try
color=get(Parent,'Color');
catch %#ok<CTCH>
color=[1 1 1];
end
end
p=uipanel('Parent', Parent,...
'Units', Units,...
'Position', Position,...
'BorderType', 'none',...
'BackgroundColor', color,...
'Tag', 'jcontroluipanel');
return
end